Class: Dropbox::Sign::AccountApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountApi

Returns a new instance of AccountApi.



22
23
24
 
# File 'lib/dropbox-sign/api/account_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/account_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#account_create(account_create_request, opts = {}) ⇒ AccountCreateResponse

Create Account Creates a new Dropbox Sign Account that is associated with the specified ‘email_address`.

Parameters:

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

    the optional parameters

Returns:



30
31
32
33
 
# File 'lib/dropbox-sign/api/account_api.rb', line 30

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

#account_create_with_http_info(account_create_request, opts = {}) ⇒ Array<(AccountCreateResponse, Integer, Hash)>

Create Account Creates a new Dropbox Sign Account that is associated with the specified &#x60;email_address&#x60;.

Parameters:

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

    the optional parameters

Returns:

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

    AccountCreateResponse data, response status code and response headers



40
41
42
43
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
124
125
126
127
128
129
130
131
132
 
# File 'lib/dropbox-sign/api/account_api.rb', line 40

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.account_create ...'
  end
  # verify the required parameter 'account_create_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_create_request' when calling AccountApi.account_create"
  end
  # resource path
  local_var_path = '/account/create'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  post_body = {}
  form_params = opts[:form_params] || {}
  result = @api_client.generate_form_data(
    ,
    Dropbox::Sign::AccountCreateRequest.openapi_types
  )

  # form parameters
  if result[:has_file]
    form_params = opts[:form_params] || result[:params]
    header_params['Content-Type'] = 'multipart/form-data'
  else
    # http body (model)
    post_body = opts[:debug_body] || result[:params]
  end

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

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

  new_options = opts.merge(
    :operation => :"AccountApi.account_create",
    :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(:POST, 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::AccountCreateResponse"
      )

      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: AccountApi#account_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_get(opts = {}) ⇒ AccountGetResponse

Get Account Returns the properties and settings of your Account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    &#x60;account_id&#x60; or &#x60;email_address&#x60; is required. If both are provided, the account id prevails. The ID of the Account.

  • :email_address (String) —

    &#x60;account_id&#x60; or &#x60;email_address&#x60; is required, If both are provided, the account id prevails. The email address of the Account.

Returns:



140
141
142
143
 
# File 'lib/dropbox-sign/api/account_api.rb', line 140

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

#account_get_with_http_info(opts = {}) ⇒ Array<(AccountGetResponse, Integer, Hash)>

Get Account Returns the properties and settings of your Account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    &#x60;account_id&#x60; or &#x60;email_address&#x60; is required. If both are provided, the account id prevails. The ID of the Account.

  • :email_address (String) —

    &#x60;account_id&#x60; or &#x60;email_address&#x60; is required, If both are provided, the account id prevails. The email address of the Account.

Returns:

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

    AccountGetResponse data, response status code and response headers



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
218
219
220
221
222
223
224
225
226
 
# File 'lib/dropbox-sign/api/account_api.rb', line 151

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.account_get ...'
  end
  # resource path
  local_var_path = '/account'

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"AccountApi.account_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::AccountGetResponse"
      )

      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: AccountApi#account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_update(account_update_request, opts = {}) ⇒ AccountGetResponse

Update Account Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.

Parameters:

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

    the optional parameters

Returns:



233
234
235
236
 
# File 'lib/dropbox-sign/api/account_api.rb', line 233

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

#account_update_with_http_info(account_update_request, opts = {}) ⇒ Array<(AccountGetResponse, Integer, Hash)>

Update Account Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.

Parameters:

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

    the optional parameters

Returns:

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

    AccountGetResponse data, response status code and response headers



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/dropbox-sign/api/account_api.rb', line 243

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.account_update ...'
  end
  # verify the required parameter 'account_update_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_update_request' when calling AccountApi.account_update"
  end
  # resource path
  local_var_path = '/account'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  post_body = {}
  form_params = opts[:form_params] || {}
  result = @api_client.generate_form_data(
    ,
    Dropbox::Sign::AccountUpdateRequest.openapi_types
  )

  # form parameters
  if result[:has_file]
    form_params = opts[:form_params] || result[:params]
    header_params['Content-Type'] = 'multipart/form-data'
  else
    # http body (model)
    post_body = opts[:debug_body] || result[:params]
  end

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

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

  new_options = opts.merge(
    :operation => :"AccountApi.account_update",
    :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(:PUT, 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::AccountGetResponse"
      )

      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: AccountApi#account_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_verify(account_verify_request, opts = {}) ⇒ AccountVerifyResponse

Verify Account Verifies whether an Dropbox Sign Account exists for the given email address.

Parameters:

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

    the optional parameters

Returns:



342
343
344
345
 
# File 'lib/dropbox-sign/api/account_api.rb', line 342

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

#account_verify_with_http_info(account_verify_request, opts = {}) ⇒ Array<(AccountVerifyResponse, Integer, Hash)>

Verify Account Verifies whether an Dropbox Sign Account exists for the given email address.

Parameters:

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

    the optional parameters

Returns:

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

    AccountVerifyResponse data, response status code and response headers



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/dropbox-sign/api/account_api.rb', line 352

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.account_verify ...'
  end
  # verify the required parameter 'account_verify_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_verify_request' when calling AccountApi.account_verify"
  end
  # resource path
  local_var_path = '/account/verify'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  post_body = {}
  form_params = opts[:form_params] || {}
  result = @api_client.generate_form_data(
    ,
    Dropbox::Sign::AccountVerifyRequest.openapi_types
  )

  # form parameters
  if result[:has_file]
    form_params = opts[:form_params] || result[:params]
    header_params['Content-Type'] = 'multipart/form-data'
  else
    # http body (model)
    post_body = opts[:debug_body] || result[:params]
  end

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

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

  new_options = opts.merge(
    :operation => :"AccountApi.account_verify",
    :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(:POST, 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::AccountVerifyResponse"
      )

      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: AccountApi#account_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end