dropbox-sign 1.3.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -2
  3. data/README.md +4 -4
  4. data/VERSION +1 -1
  5. data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
  6. data/docs/EmbeddedEditUrlRequest.md +1 -1
  7. data/docs/EventCallbackRequestEvent.md +1 -1
  8. data/docs/SignatureRequestApi.md +7 -7
  9. data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
  10. data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
  11. data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
  12. data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
  13. data/docs/SignatureRequestResponse.md +2 -0
  14. data/docs/SignatureRequestSendRequest.md +5 -5
  15. data/docs/SignatureRequestSendWithTemplateRequest.md +2 -2
  16. data/docs/SignatureRequestUpdateRequest.md +2 -2
  17. data/docs/SubAttachment.md +1 -1
  18. data/docs/SubCustomField.md +1 -1
  19. data/docs/SubFieldOptions.md +1 -1
  20. data/docs/SubFormFieldsPerDocumentBase.md +2 -2
  21. data/docs/SubFormFieldsPerDocumentDateSigned.md +1 -1
  22. data/docs/SubFormFieldsPerDocumentDropdown.md +1 -1
  23. data/docs/SubFormFieldsPerDocumentHyperlink.md +1 -1
  24. data/docs/SubFormFieldsPerDocumentText.md +2 -2
  25. data/docs/SubFormFieldsPerDocumentTextMerge.md +1 -1
  26. data/docs/SubSignatureRequestGroupedSigners.md +1 -1
  27. data/docs/SubSignatureRequestSigner.md +1 -1
  28. data/docs/SubSignatureRequestTemplateSigner.md +1 -1
  29. data/docs/SubSigningOptions.md +1 -1
  30. data/docs/TeamAddMemberRequest.md +1 -1
  31. data/docs/TeamRemoveMemberRequest.md +2 -2
  32. data/docs/TemplateAddUserRequest.md +2 -2
  33. data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
  34. data/docs/TemplateCreateRequest.md +2 -2
  35. data/docs/TemplateResponseDocument.md +1 -1
  36. data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
  37. data/docs/UnclaimedDraftApi.md +3 -3
  38. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
  39. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +3 -3
  40. data/docs/UnclaimedDraftCreateRequest.md +2 -2
  41. data/examples/SignatureRequestEdit.rb +58 -0
  42. data/examples/SignatureRequestEditEmbedded.rb +48 -0
  43. data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +41 -0
  44. data/examples/SignatureRequestEditWithTemplate.rb +52 -0
  45. data/lib/dropbox-sign/api/api_app_api.rb +1 -1
  46. data/lib/dropbox-sign/api/signature_request_api.rb +14 -14
  47. data/lib/dropbox-sign/api/team_api.rb +1 -1
  48. data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
  49. data/lib/dropbox-sign/event_callback_helper.rb +1 -1
  50. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +13 -1
  51. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
  52. data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -7
  53. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
  54. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
  55. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +4 -4
  56. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +1 -1
  57. data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
  58. data/lib/dropbox-sign/models/signature_request_send_request.rb +5 -5
  59. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +2 -2
  60. data/lib/dropbox-sign/models/signature_request_update_request.rb +2 -2
  61. data/lib/dropbox-sign/models/sub_attachment.rb +1 -1
  62. data/lib/dropbox-sign/models/sub_custom_field.rb +1 -1
  63. data/lib/dropbox-sign/models/sub_field_options.rb +1 -1
  64. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
  65. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +3 -1
  66. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +3 -1
  67. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +3 -1
  68. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +4 -2
  69. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +3 -1
  70. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +1 -1
  71. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
  72. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
  73. data/lib/dropbox-sign/models/sub_signing_options.rb +1 -1
  74. data/lib/dropbox-sign/models/team_add_member_request.rb +1 -1
  75. data/lib/dropbox-sign/models/team_remove_member_request.rb +2 -2
  76. data/lib/dropbox-sign/models/template_add_user_request.rb +2 -2
  77. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +2 -2
  78. data/lib/dropbox-sign/models/template_create_request.rb +2 -2
  79. data/lib/dropbox-sign/models/template_response_document.rb +1 -1
  80. data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +1 -1
  81. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +4 -4
  82. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +3 -3
  83. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +2 -2
  84. data/lib/dropbox-sign/version.rb +1 -1
  85. data/openapi-config.yaml +1 -1
  86. data/openapi-sdk.yaml +154 -121
  87. data/spec/event_callback_helper_spec.rb +17 -3
  88. data/templates/event_callback_helper.mustache +1 -1
  89. data/test_fixtures/EventCallbackHelper_AccountCallbacks.json +82 -0
  90. data/test_fixtures/{EventCallbackHelper.json → EventCallbackHelper_AppCallbacks.json} +8 -4
  91. data/test_fixtures/SignatureRequestSendRequest.json +12 -6
  92. data/test_fixtures/SubFormFieldsPerDocument.json +8 -4
  93. metadata +14 -9
@@ -42,7 +42,7 @@ module Dropbox::Sign
42
42
  # @return [Boolean]
43
43
  attr_accessor :allow_decline
44
44
 
45
- # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan and higher.
45
+ # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
46
46
  # @return [Boolean]
47
47
  attr_accessor :allow_reassign
48
48
 
@@ -80,7 +80,7 @@ module Dropbox::Sign
80
80
  # @return [Array<SubFormFieldRule>]
81
81
  attr_accessor :form_field_rules
82
82
 
83
- # The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
83
+ # The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
84
84
  # @return [Array<SubFormFieldsPerDocumentBase>]
85
85
  attr_accessor :form_fields_per_document
86
86
 
@@ -151,11 +151,11 @@ module Dropbox::Sign
151
151
  # @return [Boolean]
152
152
  attr_accessor :use_text_tags
153
153
 
154
- # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
154
+ # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
155
155
  # @return [Boolean]
156
156
  attr_accessor :populate_auto_fill_fields
157
157
 
158
- # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **Note**: This does not correspond to the **expires_at** returned in the response.
158
+ # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.
159
159
  # @return [Integer, nil]
160
160
  attr_accessor :expires_at
161
161
 
@@ -34,7 +34,7 @@ module Dropbox::Sign
34
34
  # @return [Boolean]
35
35
  attr_accessor :allow_decline
36
36
 
37
- # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan and higher.
37
+ # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
38
38
  # @return [Boolean]
39
39
  attr_accessor :allow_reassign
40
40
 
@@ -84,7 +84,7 @@ module Dropbox::Sign
84
84
  # @return [Hash<String, Object>]
85
85
  attr_accessor :metadata
86
86
 
87
- # This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). - `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience. **Note**: This parameter overwrites `show_preview=1` (if set).
87
+ # This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). - `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience. **NOTE:** This parameter overwrites `show_preview=1` (if set).
88
88
  # @return [Boolean]
89
89
  attr_accessor :preview_only
90
90
 
@@ -127,7 +127,7 @@ module Dropbox::Sign
127
127
  # @return [String]
128
128
  attr_accessor :title
129
129
 
130
- # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
130
+ # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
131
131
  # @return [Boolean]
132
132
  attr_accessor :populate_auto_fill_fields
133
133
 
@@ -61,7 +61,7 @@ module Dropbox::Sign
61
61
  # @return [Array<SubFormFieldRule>]
62
62
  attr_accessor :form_field_rules
63
63
 
64
- # The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
64
+ # The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
65
65
  # @return [Array<SubFormFieldsPerDocumentBase>]
66
66
  attr_accessor :form_fields_per_document
67
67
 
@@ -108,7 +108,7 @@ module Dropbox::Sign
108
108
  # @return [Boolean]
109
109
  attr_accessor :use_text_tags
110
110
 
111
- # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **Note**: This does not correspond to the **expires_at** returned in the response.
111
+ # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.
112
112
  # @return [Integer, nil]
113
113
  attr_accessor :expires_at
114
114
 
@@ -14,5 +14,5 @@ module Dropbox
14
14
  end
15
15
 
16
16
  module Dropbox::Sign
17
- VERSION = '1.3.0'
17
+ VERSION = '1.4.1'
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.3.0
12
+ gemVersion: 1.4.1
13
13
  sortModelPropertiesByRequiredFlag: true
14
14
  legacyDiscriminatorBehavior: true
15
15
  gitUserId: hellosign