docusign_click 1.2.2 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/docusign_click.gemspec +1 -1
  4. data/lib/docusign_click/api/accounts_api.rb +242 -188
  5. data/lib/docusign_click/client/api_client.rb +2 -2
  6. data/lib/docusign_click/client/api_error.rb +1 -1
  7. data/lib/docusign_click/configuration.rb +1 -1
  8. data/lib/docusign_click/models/bulk_clickwrap_request.rb +205 -0
  9. data/lib/docusign_click/models/clickwrap_agreements_response.rb +6 -6
  10. data/lib/docusign_click/models/clickwrap_delete_response.rb +7 -6
  11. data/lib/docusign_click/models/clickwrap_request.rb +16 -13
  12. data/lib/docusign_click/models/clickwrap_scheduled_reacceptance.rb +4 -4
  13. data/lib/docusign_click/models/clickwrap_transfer_request.rb +4 -3
  14. data/lib/docusign_click/models/clickwrap_version.rb +13 -12
  15. data/lib/docusign_click/models/clickwrap_version_delete_response.rb +15 -14
  16. data/lib/docusign_click/models/clickwrap_version_response.rb +18 -16
  17. data/lib/docusign_click/models/clickwrap_version_summary_response.rb +16 -15
  18. data/lib/docusign_click/models/clickwrap_versions_delete_response.rb +4 -4
  19. data/lib/docusign_click/models/clickwrap_versions_paged_response.rb +9 -8
  20. data/lib/docusign_click/models/clickwrap_versions_response.rb +6 -5
  21. data/lib/docusign_click/models/clickwraps_delete_response.rb +2 -2
  22. data/lib/docusign_click/models/data_field.rb +1 -1
  23. data/lib/docusign_click/models/display_settings.rb +20 -19
  24. data/lib/docusign_click/models/document.rb +10 -9
  25. data/lib/docusign_click/models/error_details.rb +4 -3
  26. data/lib/docusign_click/models/service_information.rb +7 -7
  27. data/lib/docusign_click/models/service_version.rb +3 -3
  28. data/lib/docusign_click/models/user_agreement_request.rb +19 -8
  29. data/lib/docusign_click/models/user_agreement_response.rb +43 -20
  30. data/lib/docusign_click/version.rb +2 -2
  31. data/lib/docusign_click.rb +2 -1
  32. metadata +3 -2
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocuSign Click API
3
3
 
4
- #DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
4
+ #Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
  Contact: devcenter@docusign.com
@@ -13,60 +13,67 @@ require 'date'
13
13
 
14
14
  module DocuSign_Click
15
15
  class UserAgreementResponse
16
- #
16
+ # The external account number (int) or account ID GUID.
17
17
  attr_accessor :account_id
18
18
 
19
- #
19
+ # Date that the client last completed the agreement. This property is null if `agreementUrl` is not null and `status` is not `agreed`.
20
20
  attr_accessor :agreed_on
21
21
 
22
- #
22
+ # The agreement ID.
23
23
  attr_accessor :agreement_id
24
24
 
25
- #
25
+ # When not null, an agreement is required for user specified by `clientUserId`. When missing the user specified by `clientUserId` has already agreed and does not require a new acceptance. Use this URL to render the agreement in a web page. <!-- or redirected to when providing redirect_url as a query parameter. -->
26
26
  attr_accessor :agreement_url
27
27
 
28
- #
28
+ # The ID of the clickwrap.
29
29
  attr_accessor :clickwrap_id
30
30
 
31
- #
31
+ # A unique value that identifies a user.\\nYou can use anything that your system uses\\nto identify unique users, such as\\nemployee IDs, email addresses, and surrogate keys as the value of `clientUserId`.\\n\\nA clickwrap with a specific `clientUserId` will not appear again\\nonce it has been accepted.\\n\"
32
32
  attr_accessor :client_user_id
33
33
 
34
- #
34
+ # **True** if consumer disclosure was required by this agreement.
35
35
  attr_accessor :consumer_disclosure_enabled
36
36
 
37
- #
37
+ # The customer-branded HTML with the Electronic Record and Signature Disclosure information
38
38
  attr_accessor :consumer_disclosure_html
39
39
 
40
- #
40
+ # The date when the clickwrap was created. May be null.
41
41
  attr_accessor :created_on
42
42
 
43
- #
43
+ # The list of all the data fields available for the clickwrap (custom fields and standard fields).
44
+ attr_accessor :data_fields
45
+
46
+ # The date when the user declined the most recent required agreement. This property is valid only when `status` is `declined`. Otherwise it is null.
44
47
  attr_accessor :declined_on
45
48
 
46
- #
49
+ # This property specifies the data used to create a clickwrap with [dynamic content][]. [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content
47
50
  attr_accessor :document_data
48
51
 
49
- #
52
+ # An array of documents.
50
53
  attr_accessor :documents
51
54
 
52
- #
55
+ # A customer-defined string you can use in requests. This string will appear in the corresponding response.
53
56
  attr_accessor :metadata
54
57
 
58
+ # The URL redirected to after the agreement was completed.
59
+ attr_accessor :return_url
60
+
61
+ # The display settings for this agreement.
55
62
  attr_accessor :settings
56
63
 
57
- #
64
+ # User agreement status. One of: - `created` - `agreed` - `declined`
58
65
  attr_accessor :status
59
66
 
60
- #
67
+ # This property specifies the custom style provided when the agreement was created by [customizing the template appearance][]. [customizing the template appearance]: /docs/click-api/click101/customize-elastic-template-appearance/
61
68
  attr_accessor :style
62
69
 
63
- #
70
+ # The human-readable semver version string.
64
71
  attr_accessor :version
65
72
 
66
- #
73
+ # The ID of the version.
67
74
  attr_accessor :version_id
68
75
 
69
- #
76
+ # Version of the clickwrap.
70
77
  attr_accessor :version_number
71
78
 
72
79
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -81,10 +88,12 @@ module DocuSign_Click
81
88
  :'consumer_disclosure_enabled' => :'consumerDisclosureEnabled',
82
89
  :'consumer_disclosure_html' => :'consumerDisclosureHtml',
83
90
  :'created_on' => :'createdOn',
91
+ :'data_fields' => :'dataFields',
84
92
  :'declined_on' => :'declinedOn',
85
93
  :'document_data' => :'documentData',
86
94
  :'documents' => :'documents',
87
95
  :'metadata' => :'metadata',
96
+ :'return_url' => :'returnUrl',
88
97
  :'settings' => :'settings',
89
98
  :'status' => :'status',
90
99
  :'style' => :'style',
@@ -106,10 +115,12 @@ module DocuSign_Click
106
115
  :'consumer_disclosure_enabled' => :'BOOLEAN',
107
116
  :'consumer_disclosure_html' => :'String',
108
117
  :'created_on' => :'Object',
118
+ :'data_fields' => :'Array<DataField>',
109
119
  :'declined_on' => :'Object',
110
120
  :'document_data' => :'Hash<String, String>',
111
121
  :'documents' => :'Array<Document>',
112
122
  :'metadata' => :'String',
123
+ :'return_url' => :'String',
113
124
  :'settings' => :'DisplaySettings',
114
125
  :'status' => :'String',
115
126
  :'style' => :'Hash<String, String>',
@@ -163,6 +174,12 @@ module DocuSign_Click
163
174
  self.created_on = attributes[:'createdOn']
164
175
  end
165
176
 
177
+ if attributes.has_key?(:'dataFields')
178
+ if (value = attributes[:'dataFields']).is_a?(Array)
179
+ self.data_fields = value
180
+ end
181
+ end
182
+
166
183
  if attributes.has_key?(:'declinedOn')
167
184
  self.declined_on = attributes[:'declinedOn']
168
185
  end
@@ -183,6 +200,10 @@ module DocuSign_Click
183
200
  self.metadata = attributes[:'metadata']
184
201
  end
185
202
 
203
+ if attributes.has_key?(:'returnUrl')
204
+ self.return_url = attributes[:'returnUrl']
205
+ end
206
+
186
207
  if attributes.has_key?(:'settings')
187
208
  self.settings = attributes[:'settings']
188
209
  end
@@ -237,10 +258,12 @@ module DocuSign_Click
237
258
  consumer_disclosure_enabled == o.consumer_disclosure_enabled &&
238
259
  consumer_disclosure_html == o.consumer_disclosure_html &&
239
260
  created_on == o.created_on &&
261
+ data_fields == o.data_fields &&
240
262
  declined_on == o.declined_on &&
241
263
  document_data == o.document_data &&
242
264
  documents == o.documents &&
243
265
  metadata == o.metadata &&
266
+ return_url == o.return_url &&
244
267
  settings == o.settings &&
245
268
  status == o.status &&
246
269
  style == o.style &&
@@ -258,7 +281,7 @@ module DocuSign_Click
258
281
  # Calculates hash code according to all attributes.
259
282
  # @return [Fixnum] Hash code
260
283
  def hash
261
- [account_id, agreed_on, agreement_id, agreement_url, clickwrap_id, client_user_id, consumer_disclosure_enabled, consumer_disclosure_html, created_on, declined_on, document_data, documents, metadata, settings, status, style, version, version_id, version_number].hash
284
+ [account_id, agreed_on, agreement_id, agreement_url, clickwrap_id, client_user_id, consumer_disclosure_enabled, consumer_disclosure_html, created_on, data_fields, declined_on, document_data, documents, metadata, return_url, settings, status, style, version, version_id, version_number].hash
262
285
  end
263
286
 
264
287
  # Builds the object from hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocuSign Click API
3
3
 
4
- #DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
4
+ #Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
  Contact: devcenter@docusign.com
@@ -10,5 +10,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
10
10
  =end
11
11
 
12
12
  module DocuSign_Click
13
- VERSION = '1.2.2'
13
+ VERSION = '1.3.0'
14
14
  end
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #DocuSign Click API
3
3
 
4
- #DocuSign Click lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
4
+ #Elastic signing (also known as DocuSign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your DocuSign integrations.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
  Contact: devcenter@docusign.com
@@ -19,6 +19,7 @@ require 'docusign_click/configuration'
19
19
  require 'docusign_click/client/auth/oauth'
20
20
 
21
21
  # Models
22
+ require 'docusign_click/models/bulk_clickwrap_request'
22
23
  require 'docusign_click/models/clickwrap_agreements_response'
23
24
  require 'docusign_click/models/clickwrap_delete_response'
24
25
  require 'docusign_click/models/clickwrap_request'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: docusign_click
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.2
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - DocuSign
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-10-29 00:00:00.000000000 Z
11
+ date: 2023-02-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jwt
@@ -294,6 +294,7 @@ files:
294
294
  - lib/docusign_click/client/api_error.rb
295
295
  - lib/docusign_click/client/auth/oauth.rb
296
296
  - lib/docusign_click/configuration.rb
297
+ - lib/docusign_click/models/bulk_clickwrap_request.rb
297
298
  - lib/docusign_click/models/clickwrap_agreements_response.rb
298
299
  - lib/docusign_click/models/clickwrap_delete_response.rb
299
300
  - lib/docusign_click/models/clickwrap_request.rb