Class: Dropbox::Sign::BulkSendJobApi

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/api/bulk_send_job_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BulkSendJobApi

Returns a new instance of BulkSendJobApi.



22
23
24
 
# File 'lib/dropbox-sign/api/bulk_send_job_api.rb', line 22

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/dropbox-sign/api/bulk_send_job_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#bulk_send_job_get(bulk_send_job_id, opts = {}) ⇒ BulkSendJobGetResponse

Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the ‘bulk_send_job_id` parameter.

Parameters:

  • bulk_send_job_id (String) —

    The id of the BulkSendJob to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Which page number of the BulkSendJob list to return. Defaults to `1`. (default to 1)

  • :page_size (Integer) —

    Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (default to 20)

Returns:



32
33
34
35
 
# File 'lib/dropbox-sign/api/bulk_send_job_api.rb', line 32

def bulk_send_job_get(bulk_send_job_id, opts = {})
  data, _status_code, _headers = bulk_send_job_get_with_http_info(bulk_send_job_id, opts)
  data
end

#bulk_send_job_get_with_http_info(bulk_send_job_id, opts = {}) ⇒ Array<(BulkSendJobGetResponse, Integer, Hash)>

Get Bulk Send Job Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.

Parameters:

  • bulk_send_job_id (String) —

    The id of the BulkSendJob to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (default to 1)

  • :page_size (Integer) —

    Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (default to 20)

Returns:

  • (Array<(BulkSendJobGetResponse, Integer, Hash)>) —

    BulkSendJobGetResponse data, response status code and response headers



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/dropbox-sign/api/bulk_send_job_api.rb', line 44

def bulk_send_job_get_with_http_info(bulk_send_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkSendJobApi.bulk_send_job_get ...'
  end
  # verify the required parameter 'bulk_send_job_id' is set
  if @api_client.config.client_side_validation && bulk_send_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_send_job_id' when calling BulkSendJobApi.bulk_send_job_get"
  end
  # resource path
  local_var_path = '/bulk_send_job/{bulk_send_job_id}'.sub('{' + 'bulk_send_job_id' + '}', CGI.escape(bulk_send_job_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  post_body = {}
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BulkSendJobGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :operation => :"BulkSendJobApi.bulk_send_job_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  begin
    data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  rescue Dropbox::Sign::ApiError => e
    if e.code === 200
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::BulkSendJobGetResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

    range_code = "4XX".split('').first
    range_code_left = "#{range_code}00".to_i
    range_code_right = "#{range_code}99".to_i
    if e.code >= range_code_left && e.code <= range_code_right
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::ErrorResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

  end

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkSendJobApi#bulk_send_job_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bulk_send_job_list(opts = {}) ⇒ BulkSendJobListResponse

List Bulk Send Jobs Returns a list of BulkSendJob that you can access.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (default to 1)

  • :page_size (Integer) —

    Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (default to 20)

Returns:



131
132
133
134
 
# File 'lib/dropbox-sign/api/bulk_send_job_api.rb', line 131

def bulk_send_job_list(opts = {})
  data, _status_code, _headers = bulk_send_job_list_with_http_info(opts)
  data
end

#bulk_send_job_list_with_http_info(opts = {}) ⇒ Array<(BulkSendJobListResponse, Integer, Hash)>

List Bulk Send Jobs Returns a list of BulkSendJob that you can access.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (default to 1)

  • :page_size (Integer) —

    Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (default to 20)

Returns:

  • (Array<(BulkSendJobListResponse, Integer, Hash)>) —

    BulkSendJobListResponse data, response status code and response headers



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/dropbox-sign/api/bulk_send_job_api.rb', line 142

def bulk_send_job_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkSendJobApi.bulk_send_job_list ...'
  end
  # resource path
  local_var_path = '/bulk_send_job/list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  post_body = {}
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BulkSendJobListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :operation => :"BulkSendJobApi.bulk_send_job_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  begin
    data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  rescue Dropbox::Sign::ApiError => e
    if e.code === 200
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::BulkSendJobListResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

    range_code = "4XX".split('').first
    range_code_left = "#{range_code}00".to_i
    range_code_right = "#{range_code}99".to_i
    if e.code >= range_code_left && e.code <= range_code_right
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::ErrorResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

  end

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkSendJobApi#bulk_send_job_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end