module HelloSign::Api::BulkSendJob
Contains all the API calls for the BulkSendJob
resource. Take a look at our API Documentation on BulkSendJobs (app.hellosign.com/api/reference#BulkSendJob) for more information about this.
@author [hellosign]
Public Instance Methods
get_bulk_send_job(opts)
click to toggle source
Retrieves a BulkSendJob
with a given ID @option opts [String] bulk_send_job_id The BulkSendJob
ID to retrieve.
@return [HelloSign::Resource::BulkSendJob]
@example
bulk_send_job = @client.get_bulk_send_job bulk_send_job_id: 'af299494bdcad318b4856aa34aa263dbdaaee9ab'
# File lib/hello_sign/api/bulk_send_job.rb, line 40 def get_bulk_send_job(opts) path = "/bulk_send_job/#{opts[:bulk_send_job_id]}" HelloSign::Resource::BulkSendJob.new get(path) end
get_bulk_send_jobs(opts={})
click to toggle source
Returns a list of BulkSendJobs that your Account
can access. @option opts [Integer] page Sets the page number of the list to return. Defaults to 1. (optional) @option opts [Integer] page_size Determines the number of BulkSendJobs returned per page. Defaults to 20. (optional)
@return [HelloSign::Resource::ResourceArray]
@example
bulk_send_jobs = @client.get_bulk_send_jobs page: 1
# File lib/hello_sign/api/bulk_send_job.rb, line 54 def get_bulk_send_jobs(opts={}) path = '/bulk_send_job/list' path += opts[:page] ? "?page=#{opts[:page]}" : '' path += opts[:page_size] ? "&page_size=#{opts[:page_size]}" : '' HelloSign::Resource::ResourceArray.new get(path, opts), 'bulk_send_jobs', HelloSign::Resource::BulkSendJob end