Module: HelloSign::Api::BulkSendJob

Included in:
Client
Defined in:
lib/hello_sign/api/bulk_send_job.rb

Overview

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

Instance Method Summary collapse

Instance Method Details

#get_bulk_send_job(opts) ⇒ HelloSign::Resource::BulkSendJob

Retrieves a BulkSendJob with a given ID

Examples:

bulk_send_job = @client.get_bulk_send_job bulk_send_job_id: 'af299494bdcad318b4856aa34aa263dbdaaee9ab'

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • bulk_send_job_id (String) —

    The BulkSendJob ID to retrieve.

Returns:



40
41
42
43
44
 
# 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 = {}) ⇒ HelloSign::Resource::ResourceArray

Returns a list of BulkSendJobs that your Account can access.

Examples:

bulk_send_jobs = @client.get_bulk_send_jobs page: 1

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • page (Integer) —

    Sets the page number of the list to return. Defaults to 1. (optional)

  • page_size (Integer) —

    Determines the number of BulkSendJobs returned per page. Defaults to 20. (optional)

Returns:



54
55
56
57
58
59
 
# 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