Class: Dropbox::Sign::UnclaimedDraftApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UnclaimedDraftApi

Returns a new instance of UnclaimedDraftApi.



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

def api_client
  @api_client
end

Instance Method Details

#unclaimed_draft_create(unclaimed_draft_create_request, opts = {}) ⇒ UnclaimedDraftCreateResponse

Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.

Parameters:

Returns:



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

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

#unclaimed_draft_create_embedded(unclaimed_draft_create_embedded_request, opts = {}) ⇒ UnclaimedDraftCreateResponse

Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a ‘404`. For this embedded endpoint the `requester_email_address` parameter is required. NOTE: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.

Parameters:

Returns:



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

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

#unclaimed_draft_create_embedded_with_http_info(unclaimed_draft_create_embedded_request, opts = {}) ⇒ Array<(UnclaimedDraftCreateResponse, Integer, Hash)>

Create Embedded Unclaimed Draft Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the &quot;Request signature&quot; page with the Draft loaded. Subsequent access to the claim URL will result in a &#x60;404&#x60;. For this embedded endpoint the &#x60;requester_email_address&#x60; parameter is required. NOTE: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.

Parameters:

Returns:



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/dropbox-sign/api/unclaimed_draft_api.rb', line 149

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  post_body = {}
  form_params = opts[:form_params] || {}
  result = @api_client.generate_form_data(
    unclaimed_draft_create_embedded_request,
    Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.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] || 'UnclaimedDraftCreateResponse'

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

  new_options = opts.merge(
    :operation => :"UnclaimedDraftApi.unclaimed_draft_create_embedded",
    :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::UnclaimedDraftCreateResponse"
      )

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

#unclaimed_draft_create_embedded_with_template(unclaimed_draft_create_embedded_with_template_request, opts = {}) ⇒ UnclaimedDraftCreateResponse

Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a ‘404`. For this embedded endpoint the `requester_email_address` parameter is required. NOTE: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.

Parameters:

Returns:



248
249
250
251
 
# File 'lib/dropbox-sign/api/unclaimed_draft_api.rb', line 248

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

#unclaimed_draft_create_embedded_with_template_with_http_info(unclaimed_draft_create_embedded_with_template_request, opts = {}) ⇒ Array<(UnclaimedDraftCreateResponse, Integer, Hash)>

Create Embedded Unclaimed Draft with Template Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the &quot;Request signature&quot; page with the Draft loaded. Subsequent access to the claim URL will result in a &#x60;404&#x60;. For this embedded endpoint the &#x60;requester_email_address&#x60; parameter is required. NOTE: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.

Parameters:

Returns:



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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/dropbox-sign/api/unclaimed_draft_api.rb', line 258

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

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  post_body = {}
  form_params = opts[:form_params] || {}
  result = @api_client.generate_form_data(
    unclaimed_draft_create_embedded_with_template_request,
    Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.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] || 'UnclaimedDraftCreateResponse'

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

  new_options = opts.merge(
    :operation => :"UnclaimedDraftApi.unclaimed_draft_create_embedded_with_template",
    :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::UnclaimedDraftCreateResponse"
      )

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

#unclaimed_draft_create_with_http_info(unclaimed_draft_create_request, opts = {}) ⇒ Array<(UnclaimedDraftCreateResponse, Integer, Hash)>

Create Unclaimed Draft Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the &quot;Sign and send&quot; or the &quot;Request signature&quot; page with the Draft loaded. Subsequent access to the claim URL will result in a 404.

Parameters:

Returns:



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/unclaimed_draft_api.rb', line 40

def unclaimed_draft_create_with_http_info(unclaimed_draft_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnclaimedDraftApi.unclaimed_draft_create ...'
  end
  # verify the required parameter 'unclaimed_draft_create_request' is set
  if @api_client.config.client_side_validation && unclaimed_draft_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'unclaimed_draft_create_request' when calling UnclaimedDraftApi.unclaimed_draft_create"
  end
  # resource path
  local_var_path = '/unclaimed_draft/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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  post_body = {}
  form_params = opts[:form_params] || {}
  result = @api_client.generate_form_data(
    unclaimed_draft_create_request,
    Dropbox::Sign::UnclaimedDraftCreateRequest.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] || 'UnclaimedDraftCreateResponse'

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

  new_options = opts.merge(
    :operation => :"UnclaimedDraftApi.unclaimed_draft_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::UnclaimedDraftCreateResponse"
      )

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

#unclaimed_draft_edit_and_resend(signature_request_id, unclaimed_draft_edit_and_resend_request, opts = {}) ⇒ UnclaimedDraftCreateResponse

Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter ‘test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester’s email address will remain unchanged if ‘requester_email_address` parameter is not set. NOTE: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.

Parameters:

  • signature_request_id (String) —

    The ID of the signature request to edit and resend.

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

    the optional parameters

Returns:



358
359
360
361
 
# File 'lib/dropbox-sign/api/unclaimed_draft_api.rb', line 358

def unclaimed_draft_edit_and_resend(signature_request_id, unclaimed_draft_edit_and_resend_request, opts = {})
  data, _status_code, _headers = unclaimed_draft_edit_and_resend_with_http_info(signature_request_id, unclaimed_draft_edit_and_resend_request, opts)
  data
end

#unclaimed_draft_edit_and_resend_with_http_info(signature_request_id, unclaimed_draft_edit_and_resend_request, opts = {}) ⇒ Array<(UnclaimedDraftCreateResponse, Integer, Hash)>

Edit and Resend Unclaimed Draft Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter &#x60;test_mode&#x60; can be edited prior to request. Signers can be edited in embedded editor. Requester&#39;s email address will remain unchanged if &#x60;requester_email_address&#x60; parameter is not set. NOTE: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.

Parameters:

  • signature_request_id (String) —

    The ID of the signature request to edit and resend.

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

    the optional parameters

Returns:



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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/dropbox-sign/api/unclaimed_draft_api.rb', line 369

def unclaimed_draft_edit_and_resend_with_http_info(signature_request_id, unclaimed_draft_edit_and_resend_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UnclaimedDraftApi.unclaimed_draft_edit_and_resend ...'
  end
  # verify the required parameter 'signature_request_id' is set
  if @api_client.config.client_side_validation && signature_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling UnclaimedDraftApi.unclaimed_draft_edit_and_resend"
  end
  # verify the required parameter 'unclaimed_draft_edit_and_resend_request' is set
  if @api_client.config.client_side_validation && unclaimed_draft_edit_and_resend_request.nil?
    fail ArgumentError, "Missing the required parameter 'unclaimed_draft_edit_and_resend_request' when calling UnclaimedDraftApi.unclaimed_draft_edit_and_resend"
  end
  # resource path
  local_var_path = '/unclaimed_draft/edit_and_resend/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))

  # 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']) unless header_params['Accept']
  # 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(
    unclaimed_draft_edit_and_resend_request,
    Dropbox::Sign::UnclaimedDraftEditAndResendRequest.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] || 'UnclaimedDraftCreateResponse'

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

  new_options = opts.merge(
    :operation => :"UnclaimedDraftApi.unclaimed_draft_edit_and_resend",
    :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::UnclaimedDraftCreateResponse"
      )

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