dropbox-sign 1.2.0 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: eecee0b147e45bb327b88445dcc75bcd926ccffd1ae5c1a3ff8e2a71acb0d988
4
- data.tar.gz: eed1ad5ba86b98ea71c94dd8ca63cc401f003089ea8fa8749f2b99c815c835be
3
+ metadata.gz: 4e22a931bb4accf68d5d5405904dd73ef7f5d9d0d45b0a5fc2d025fb04c379e0
4
+ data.tar.gz: b0528240b0a4d2048d2b882f43fe0ba5f53bfc23ccd4447d65851c9b5185d494
5
5
  SHA512:
6
- metadata.gz: b4f66f7788ceb2ce28ce04c4688d010dd0eaafd5dc29eea3a265d4426aaa25b6cfcb54c160de693a38a97502601fc8c3e6d263a1a9e8ff386b75da4c72460123
7
- data.tar.gz: 8f4205e27c1ec117f05aebc0db00769421d87b33a7637eee047deeb5678faae802ba1a29880ed480b786628a5dfac1f9de1d07aaf4291eedd75e25966cbacc01
6
+ metadata.gz: 14d5a2bb0750c319f28d36ea7c45eb3433327e6325966afeb56e2796cc45e60e68b86f44a2bb5e85efb5f3b891915fe9b36fb0254dc3fd7f837e054c3477c21d
7
+ data.tar.gz: be4f028205e20b2e8675795855f83a20b68778d180f07b007226f103ee1b6d74b099b4027315103d3d56bcea508cb791e092fd2b7391dc516a32902944f6f51a
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- dropbox-sign (1.2.0)
4
+ dropbox-sign (1.3.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -56,7 +56,7 @@ GEM
56
56
  unicode-display_width (>= 1.4.0, < 1.6)
57
57
  ruby-progressbar (1.11.0)
58
58
  stringio (3.0.1)
59
- typhoeus (1.4.0)
59
+ typhoeus (1.4.1)
60
60
  ethon (>= 0.9.0)
61
61
  unicode-display_width (1.5.0)
62
62
 
data/README.md CHANGED
@@ -25,7 +25,7 @@ directory that corresponds to the file you want updated.
25
25
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
26
26
 
27
27
  - API version: 3.0.0
28
- - Package version: 1.2.0
28
+ - Package version: 1.3.0
29
29
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
30
30
 
31
31
  ## Installation
@@ -46,14 +46,14 @@ gem build dropbox-sign.gemspec
46
46
  Then install the gem locally:
47
47
 
48
48
  ```shell
49
- gem install ./dropbox-sign-1.2.0.gem
49
+ gem install ./dropbox-sign-1.3.0.gem
50
50
  ```
51
51
 
52
- (for development, run `gem install --dev ./dropbox-sign-1.2.0.gem` to install the development dependencies)
52
+ (for development, run `gem install --dev ./dropbox-sign-1.3.0.gem` to install the development dependencies)
53
53
 
54
54
  Finally add this to the Gemfile:
55
55
 
56
- gem 'dropbox-sign', '~> 1.2.0'
56
+ gem 'dropbox-sign', '~> 1.3.0'
57
57
 
58
58
  ### Install from Git
59
59
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.0
1
+ 1.3.0
@@ -651,7 +651,7 @@ end
651
651
 
652
652
  ## `signature_request_files_as_file_url`
653
653
 
654
- > `<FileResponse> signature_request_files_as_file_url(signature_request_id)`
654
+ > `<FileResponse> signature_request_files_as_file_url(signature_request_id, opts)`
655
655
 
656
656
  Download Files as File Url
657
657
 
@@ -687,12 +687,12 @@ end
687
687
 
688
688
  This returns an Array which contains the response data, status code and headers.
689
689
 
690
- > `<Array(<FileResponse>, Integer, Hash)> signature_request_files_as_file_url_with_http_info(signature_request_id)`
690
+ > `<Array(<FileResponse>, Integer, Hash)> signature_request_files_as_file_url_with_http_info(signature_request_id, opts)`
691
691
 
692
692
  ```ruby
693
693
  begin
694
694
  # Download Files as File Url
695
- data, status_code, headers = api_instance.signature_request_files_as_file_url_with_http_info(signature_request_id)
695
+ data, status_code, headers = api_instance.signature_request_files_as_file_url_with_http_info(signature_request_id, opts)
696
696
  p status_code # => 2xx
697
697
  p headers # => { ... }
698
698
  p data # => <FileResponse>
@@ -706,6 +706,7 @@ end
706
706
  | Name | Type | Description | Notes |
707
707
  | ---- | ---- | ----------- | ----- |
708
708
  | `signature_request_id` | **String** | The id of the SignatureRequest to retrieve. | |
709
+ | `force_download` | **Integer** | By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional][default to 1] |
709
710
 
710
711
  ### Return type
711
712
 
data/docs/TemplateApi.md CHANGED
@@ -514,7 +514,7 @@ end
514
514
 
515
515
  ## `template_files_as_file_url`
516
516
 
517
- > `<FileResponse> template_files_as_file_url(template_id)`
517
+ > `<FileResponse> template_files_as_file_url(template_id, opts)`
518
518
 
519
519
  Get Template Files as File Url
520
520
 
@@ -550,12 +550,12 @@ end
550
550
 
551
551
  This returns an Array which contains the response data, status code and headers.
552
552
 
553
- > `<Array(<FileResponse>, Integer, Hash)> template_files_as_file_url_with_http_info(template_id)`
553
+ > `<Array(<FileResponse>, Integer, Hash)> template_files_as_file_url_with_http_info(template_id, opts)`
554
554
 
555
555
  ```ruby
556
556
  begin
557
557
  # Get Template Files as File Url
558
- data, status_code, headers = api_instance.template_files_as_file_url_with_http_info(template_id)
558
+ data, status_code, headers = api_instance.template_files_as_file_url_with_http_info(template_id, opts)
559
559
  p status_code # => 2xx
560
560
  p headers # => { ... }
561
561
  p data # => <FileResponse>
@@ -569,6 +569,7 @@ end
569
569
  | Name | Type | Description | Notes |
570
570
  | ---- | ---- | ----------- | ----- |
571
571
  | `template_id` | **String** | The id of the template files to retrieve. | |
572
+ | `force_download` | **Integer** | By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional][default to 1] |
572
573
 
573
574
  ### Return type
574
575
 
@@ -6,6 +6,6 @@
6
6
 
7
7
  | Name | Type | Description | Notes |
8
8
  | ---- | ---- | ----------- | ----- |
9
- | `template` | [```TemplateCreateResponse```](TemplateCreateResponse.md) | | |
9
+ | `template` | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | |
10
10
  | `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
11
11
 
@@ -35,4 +35,5 @@
35
35
  | `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
36
36
  | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
37
37
  | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer&#39;s information during signing.<br><br>⚠️ **Note** ⚠️: Keep your signer&#39;s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
38
+ | `allow_ccs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to false] |
38
39
 
@@ -724,6 +724,7 @@ module Dropbox::Sign
724
724
  # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
725
725
  # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
726
726
  # @param [Hash] opts the optional parameters
727
+ # @option opts [Integer] :force_download By default when opening the &#x60;file_url&#x60; a browser will download the PDF and save it locally. When set to &#x60;0&#x60; the PDF file will be displayed in the browser. (default to 1)
727
728
  # @return [FileResponse]
728
729
  def signature_request_files_as_file_url(signature_request_id, opts = {})
729
730
  data, _status_code, _headers = signature_request_files_as_file_url_with_http_info(signature_request_id, opts)
@@ -734,6 +735,7 @@ module Dropbox::Sign
734
735
  # Obtain a copy of the current documents specified by the &#x60;signature_request_id&#x60; parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead.
735
736
  # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
736
737
  # @param [Hash] opts the optional parameters
738
+ # @option opts [Integer] :force_download By default when opening the &#x60;file_url&#x60; a browser will download the PDF and save it locally. When set to &#x60;0&#x60; the PDF file will be displayed in the browser.
737
739
  # @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
738
740
  def signature_request_files_as_file_url_with_http_info(signature_request_id, opts = {})
739
741
  if @api_client.config.debugging
@@ -748,6 +750,7 @@ module Dropbox::Sign
748
750
 
749
751
  # query parameters
750
752
  query_params = opts[:query_params] || {}
753
+ query_params[:'force_download'] = opts[:'force_download'] if !opts[:'force_download'].nil?
751
754
 
752
755
  # header parameters
753
756
  header_params = opts[:header_params] || {}
@@ -621,6 +621,7 @@ module Dropbox::Sign
621
621
  # Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
622
622
  # @param template_id [String] The id of the template files to retrieve.
623
623
  # @param [Hash] opts the optional parameters
624
+ # @option opts [Integer] :force_download By default when opening the &#x60;file_url&#x60; a browser will download the PDF and save it locally. When set to &#x60;0&#x60; the PDF file will be displayed in the browser. (default to 1)
624
625
  # @return [FileResponse]
625
626
  def template_files_as_file_url(template_id, opts = {})
626
627
  data, _status_code, _headers = template_files_as_file_url_with_http_info(template_id, opts)
@@ -631,6 +632,7 @@ module Dropbox::Sign
631
632
  # Obtain a copy of the current documents specified by the &#x60;template_id&#x60; parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead. In this case please wait for the &#x60;template_created&#x60; callback event.
632
633
  # @param template_id [String] The id of the template files to retrieve.
633
634
  # @param [Hash] opts the optional parameters
635
+ # @option opts [Integer] :force_download By default when opening the &#x60;file_url&#x60; a browser will download the PDF and save it locally. When set to &#x60;0&#x60; the PDF file will be displayed in the browser.
634
636
  # @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
635
637
  def template_files_as_file_url_with_http_info(template_id, opts = {})
636
638
  if @api_client.config.debugging
@@ -645,6 +647,7 @@ module Dropbox::Sign
645
647
 
646
648
  # query parameters
647
649
  query_params = opts[:query_params] || {}
650
+ query_params[:'force_download'] = opts[:'force_download'] if !opts[:'force_download'].nil?
648
651
 
649
652
  # header parameters
650
653
  header_params = opts[:header_params] || {}
@@ -18,7 +18,7 @@ end
18
18
 
19
19
  module Dropbox::Sign
20
20
  class TemplateCreateResponse
21
- # @return [TemplateCreateResponse]
21
+ # @return [TemplateCreateResponseTemplate]
22
22
  attr_accessor :template
23
23
 
24
24
  # A list of warnings.
@@ -46,7 +46,7 @@ module Dropbox::Sign
46
46
  # Attribute type mapping.
47
47
  def self.openapi_types
48
48
  {
49
- :'template' => :'TemplateCreateResponse',
49
+ :'template' => :'TemplateCreateResponseTemplate',
50
50
  :'warnings' => :'Array<WarningResponse>'
51
51
  }
52
52
  end
@@ -131,6 +131,10 @@ module Dropbox::Sign
131
131
  # @return [Boolean]
132
132
  attr_accessor :populate_auto_fill_fields
133
133
 
134
+ # This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
135
+ # @return [Boolean]
136
+ attr_accessor :allow_ccs
137
+
134
138
  # Attribute mapping from ruby-style variable name to JSON key.
135
139
  def self.attribute_map
136
140
  {
@@ -162,7 +166,8 @@ module Dropbox::Sign
162
166
  :'subject' => :'subject',
163
167
  :'test_mode' => :'test_mode',
164
168
  :'title' => :'title',
165
- :'populate_auto_fill_fields' => :'populate_auto_fill_fields'
169
+ :'populate_auto_fill_fields' => :'populate_auto_fill_fields',
170
+ :'allow_ccs' => :'allow_ccs'
166
171
  }
167
172
  end
168
173
 
@@ -207,7 +212,8 @@ module Dropbox::Sign
207
212
  :'subject' => :'String',
208
213
  :'test_mode' => :'Boolean',
209
214
  :'title' => :'String',
210
- :'populate_auto_fill_fields' => :'Boolean'
215
+ :'populate_auto_fill_fields' => :'Boolean',
216
+ :'allow_ccs' => :'Boolean'
211
217
  }
212
218
  end
213
219
 
@@ -405,6 +411,12 @@ module Dropbox::Sign
405
411
  else
406
412
  self.populate_auto_fill_fields = false
407
413
  end
414
+
415
+ if attributes.key?(:'allow_ccs')
416
+ self.allow_ccs = attributes[:'allow_ccs']
417
+ else
418
+ self.allow_ccs = false
419
+ end
408
420
  end
409
421
 
410
422
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -519,7 +531,8 @@ module Dropbox::Sign
519
531
  subject == o.subject &&
520
532
  test_mode == o.test_mode &&
521
533
  title == o.title &&
522
- populate_auto_fill_fields == o.populate_auto_fill_fields
534
+ populate_auto_fill_fields == o.populate_auto_fill_fields &&
535
+ allow_ccs == o.allow_ccs
523
536
  end
524
537
 
525
538
  # @see the `==` method
@@ -531,7 +544,7 @@ module Dropbox::Sign
531
544
  # Calculates hash code according to all attributes.
532
545
  # @return [Integer] Hash code
533
546
  def hash
534
- [client_id, requester_email_address, template_ids, allow_decline, allow_reassign, ccs, custom_fields, editor_options, field_options, files, file_urls, force_signer_roles, force_subject_message, hold_request, is_for_embedded_signing, message, metadata, preview_only, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, title, populate_auto_fill_fields].hash
547
+ [client_id, requester_email_address, template_ids, allow_decline, allow_reassign, ccs, custom_fields, editor_options, field_options, files, file_urls, force_signer_roles, force_subject_message, hold_request, is_for_embedded_signing, message, metadata, preview_only, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, title, populate_auto_fill_fields, allow_ccs].hash
535
548
  end
536
549
 
537
550
  # Builds the object from hash
@@ -14,5 +14,5 @@ module Dropbox
14
14
  end
15
15
 
16
16
  module Dropbox::Sign
17
- VERSION = '1.2.0'
17
+ VERSION = '1.3.0'
18
18
  end
data/openapi-config.yaml CHANGED
@@ -9,7 +9,7 @@ additionalProperties:
9
9
  gemName: dropbox-sign
10
10
  gemRequiredRubyVersion: '>= 2.7'
11
11
  moduleName: "Dropbox::Sign"
12
- gemVersion: 1.2.0
12
+ gemVersion: 1.3.0
13
13
  sortModelPropertiesByRequiredFlag: true
14
14
  legacyDiscriminatorBehavior: true
15
15
  gitUserId: hellosign
data/openapi-sdk.yaml CHANGED
@@ -2483,6 +2483,13 @@ paths:
2483
2483
  schema:
2484
2484
  type: string
2485
2485
  example: fa5c8a0b0f492d768749333ad6fcc214c111e967
2486
+ -
2487
+ name: force_download
2488
+ in: query
2489
+ description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
2490
+ schema:
2491
+ type: integer
2492
+ default: 1
2486
2493
  responses:
2487
2494
  200:
2488
2495
  description: 'successful operation'
@@ -5214,6 +5221,13 @@ paths:
5214
5221
  schema:
5215
5222
  type: string
5216
5223
  example: f57db65d3f933b5316d398057a36176831451a35
5224
+ -
5225
+ name: force_download
5226
+ in: query
5227
+ description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
5228
+ schema:
5229
+ type: integer
5230
+ default: 1
5217
5231
  responses:
5218
5232
  200:
5219
5233
  description: 'successful operation'
@@ -9074,6 +9088,10 @@ components:
9074
9088
  ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
9075
9089
  type: boolean
9076
9090
  default: false
9091
+ allow_ccs:
9092
+ description: 'This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.'
9093
+ type: boolean
9094
+ default: false
9077
9095
  type: object
9078
9096
  UnclaimedDraftEditAndResendRequest:
9079
9097
  required:
@@ -9242,20 +9260,6 @@ components:
9242
9260
  error:
9243
9261
  $ref: '#/components/schemas/ErrorResponseError'
9244
9262
  type: object
9245
- EventCallbackRequest:
9246
- title: EventCallbackRequest
9247
- required:
9248
- - event
9249
- properties:
9250
- event:
9251
- $ref: '#/components/schemas/EventCallbackRequestEvent'
9252
- account:
9253
- $ref: '#/components/schemas/AccountResponse'
9254
- signature_request:
9255
- $ref: '#/components/schemas/SignatureRequestResponse'
9256
- template:
9257
- $ref: '#/components/schemas/TemplateResponse'
9258
- type: object
9259
9263
  FileResponse:
9260
9264
  properties:
9261
9265
  file_url:
@@ -9572,69 +9576,6 @@ components:
9572
9576
  description: 'Name of the error.'
9573
9577
  type: string
9574
9578
  type: object
9575
- EventCallbackRequestEvent:
9576
- description: 'Basic information about the event that occurred.'
9577
- required:
9578
- - event_time
9579
- - event_type
9580
- - event_hash
9581
- - event_metadata
9582
- properties:
9583
- event_time:
9584
- description: 'Time the event was created (using Unix time).'
9585
- type: string
9586
- event_type:
9587
- description: 'Type of callback event that was triggered.'
9588
- type: string
9589
- enum:
9590
- - account_confirmed
9591
- - unknown_error
9592
- - file_error
9593
- - sign_url_invalid
9594
- - signature_request_viewed
9595
- - signature_request_signed
9596
- - signature_request_sent
9597
- - signature_request_all_signed
9598
- - signature_request_email_bounce
9599
- - signature_request_remind
9600
- - signature_request_incomplete_qes
9601
- - signature_request_destroyed
9602
- - signature_request_canceled
9603
- - signature_request_downloadable
9604
- - signature_request_declined
9605
- - signature_request_reassigned
9606
- - signature_request_invalid
9607
- - signature_request_prepared
9608
- - signature_request_expired
9609
- - template_created
9610
- - template_error
9611
- - callback_test
9612
- event_hash:
9613
- description: 'Generated hash used to verify source of event data.'
9614
- type: string
9615
- event_metadata:
9616
- $ref: '#/components/schemas/EventCallbackRequestEventMetadata'
9617
- type: object
9618
- EventCallbackRequestEventMetadata:
9619
- description: 'Specific metadata about the event.'
9620
- properties:
9621
- related_signature_id:
9622
- description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.'
9623
- type: string
9624
- nullable: true
9625
- reported_for_account_id:
9626
- description: 'Account ID the event was reported for.'
9627
- type: string
9628
- nullable: true
9629
- reported_for_app_id:
9630
- description: 'App ID the event was reported for.'
9631
- type: string
9632
- nullable: true
9633
- event_message:
9634
- description: 'Message about a declined or failed (due to error) signature flow.'
9635
- type: string
9636
- nullable: true
9637
- type: object
9638
9579
  ListInfoResponse:
9639
9580
  description: 'Contains pagination information about the data returned.'
9640
9581
  properties:
@@ -11178,7 +11119,7 @@ components:
11178
11119
  TemplateCreateResponse:
11179
11120
  properties:
11180
11121
  template:
11181
- $ref: '#/components/schemas/TemplateCreateResponse'
11122
+ $ref: '#/components/schemas/TemplateCreateResponseTemplate'
11182
11123
  warnings:
11183
11124
  description: 'A list of warnings.'
11184
11125
  type: array
@@ -11247,6 +11188,83 @@ components:
11247
11188
  $ref: '#/components/schemas/WarningResponse'
11248
11189
  type: object
11249
11190
  x-internal: true
11191
+ EventCallbackRequest:
11192
+ title: EventCallbackRequest
11193
+ required:
11194
+ - event
11195
+ properties:
11196
+ event:
11197
+ $ref: '#/components/schemas/EventCallbackRequestEvent'
11198
+ account:
11199
+ $ref: '#/components/schemas/AccountResponse'
11200
+ signature_request:
11201
+ $ref: '#/components/schemas/SignatureRequestResponse'
11202
+ template:
11203
+ $ref: '#/components/schemas/TemplateResponse'
11204
+ type: object
11205
+ EventCallbackRequestEvent:
11206
+ description: 'Basic information about the event that occurred.'
11207
+ required:
11208
+ - event_time
11209
+ - event_type
11210
+ - event_hash
11211
+ - event_metadata
11212
+ properties:
11213
+ event_time:
11214
+ description: 'Time the event was created (using Unix time).'
11215
+ type: string
11216
+ event_type:
11217
+ description: 'Type of callback event that was triggered.'
11218
+ type: string
11219
+ enum:
11220
+ - account_confirmed
11221
+ - unknown_error
11222
+ - file_error
11223
+ - sign_url_invalid
11224
+ - signature_request_viewed
11225
+ - signature_request_signed
11226
+ - signature_request_sent
11227
+ - signature_request_all_signed
11228
+ - signature_request_email_bounce
11229
+ - signature_request_remind
11230
+ - signature_request_incomplete_qes
11231
+ - signature_request_destroyed
11232
+ - signature_request_canceled
11233
+ - signature_request_downloadable
11234
+ - signature_request_declined
11235
+ - signature_request_reassigned
11236
+ - signature_request_invalid
11237
+ - signature_request_prepared
11238
+ - signature_request_expired
11239
+ - template_created
11240
+ - template_error
11241
+ - callback_test
11242
+ event_hash:
11243
+ description: 'Generated hash used to verify source of event data.'
11244
+ type: string
11245
+ event_metadata:
11246
+ $ref: '#/components/schemas/EventCallbackRequestEventMetadata'
11247
+ type: object
11248
+ EventCallbackRequestEventMetadata:
11249
+ description: 'Specific metadata about the event.'
11250
+ properties:
11251
+ related_signature_id:
11252
+ description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.'
11253
+ type: string
11254
+ nullable: true
11255
+ reported_for_account_id:
11256
+ description: 'Account ID the event was reported for.'
11257
+ type: string
11258
+ nullable: true
11259
+ reported_for_app_id:
11260
+ description: 'App ID the event was reported for.'
11261
+ type: string
11262
+ nullable: true
11263
+ event_message:
11264
+ description: 'Message about a declined or failed (due to error) signature flow.'
11265
+ type: string
11266
+ nullable: true
11267
+ type: object
11250
11268
  responses:
11251
11269
  EventCallbackResponse:
11252
11270
  description: 'successful operation'
@@ -11560,26 +11578,6 @@ components:
11560
11578
  summary: 'API App Update'
11561
11579
  value:
11562
11580
  $ref: examples/json/ApiAppUpdateResponseExample.json
11563
- EventCallbackAccountSignatureRequestSentExample:
11564
- summary: 'Example: signature_request_sent'
11565
- value:
11566
- $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json
11567
- EventCallbackAccountTemplateCreatedExample:
11568
- summary: 'Example: template_created'
11569
- value:
11570
- $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json
11571
- EventCallbackAppAccountConfirmedExample:
11572
- summary: 'Example: account_confirmed'
11573
- value:
11574
- $ref: examples/json/EventCallbackAppAccountConfirmedExample.json
11575
- EventCallbackAppSignatureRequestSentExample:
11576
- summary: 'Example: signature_request_sent'
11577
- value:
11578
- $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json
11579
- EventCallbackAppTemplateCreatedExample:
11580
- summary: 'Example: template_created'
11581
- value:
11582
- $ref: examples/json/EventCallbackAppTemplateCreatedExample.json
11583
11581
  SignatureRequestCreateEmbeddedResponseExample:
11584
11582
  summary: 'Create Embedded Signature Request'
11585
11583
  value:
@@ -11708,6 +11706,26 @@ components:
11708
11706
  summary: 'Unclaimed Draft Create'
11709
11707
  value:
11710
11708
  $ref: examples/json/UnclaimedDraftCreateResponseExample.json
11709
+ EventCallbackAccountSignatureRequestSentExample:
11710
+ summary: 'Example: signature_request_sent'
11711
+ value:
11712
+ $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json
11713
+ EventCallbackAccountTemplateCreatedExample:
11714
+ summary: 'Example: template_created'
11715
+ value:
11716
+ $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json
11717
+ EventCallbackAppAccountConfirmedExample:
11718
+ summary: 'Example: account_confirmed'
11719
+ value:
11720
+ $ref: examples/json/EventCallbackAppAccountConfirmedExample.json
11721
+ EventCallbackAppSignatureRequestSentExample:
11722
+ summary: 'Example: signature_request_sent'
11723
+ value:
11724
+ $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json
11725
+ EventCallbackAppTemplateCreatedExample:
11726
+ summary: 'Example: template_created'
11727
+ value:
11728
+ $ref: examples/json/EventCallbackAppTemplateCreatedExample.json
11711
11729
  requestBodies:
11712
11730
  EventCallbackAccountRequest:
11713
11731
  description: |-
@@ -62,6 +62,7 @@
62
62
  "61a832ff0d8423f91d503e76bfbcc750f7417c78"
63
63
  ],
64
64
  "test_mode": false,
65
- "title": "NDA with Acme Co."
65
+ "title": "NDA with Acme Co.",
66
+ "allow_ccs": true
66
67
  }
67
68
  }
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dropbox-sign
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dropbox
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-10-11 00:00:00.000000000 Z
11
+ date: 2024-01-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -637,16 +637,16 @@ signing_key:
637
637
  specification_version: 4
638
638
  summary: Dropbox Sign API Ruby Gem
639
639
  test_files:
640
+ - spec/api/bulk_send_job_api_spec.rb
641
+ - spec/api/account_api_spec.rb
642
+ - spec/api/embedded_api_spec.rb
640
643
  - spec/api/signature_request_api_spec.rb
644
+ - spec/api/template_api_spec.rb
641
645
  - spec/api/team_api_spec.rb
642
- - spec/api/oauth_api_spec.rb
643
646
  - spec/api/report_api_spec.rb
644
- - spec/api/embedded_api_spec.rb
647
+ - spec/api/oauth_api_spec.rb
645
648
  - spec/api/api_app_api_spec.rb
646
- - spec/api/account_api_spec.rb
647
- - spec/api/template_api_spec.rb
648
649
  - spec/api/unclaimed_draft_api_spec.rb
649
- - spec/api/bulk_send_job_api_spec.rb
650
650
  - spec/api_client_spec.rb
651
651
  - spec/configuration_spec.rb
652
652
  - spec/event_callback_helper_spec.rb