docusign_esign 3.20.0 → 3.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (150) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/lib/docusign_esign/api/accounts_api.rb +4 -4
  4. data/lib/docusign_esign/api/billing_api.rb +2 -2
  5. data/lib/docusign_esign/api/connect_api.rb +51 -0
  6. data/lib/docusign_esign/api/envelopes_api.rb +132 -65
  7. data/lib/docusign_esign/api/folders_api.rb +8 -0
  8. data/lib/docusign_esign/api/templates_api.rb +0 -130
  9. data/lib/docusign_esign/client/api_client.rb +1 -1
  10. data/lib/docusign_esign/models/account_information.rb +2 -1
  11. data/lib/docusign_esign/models/account_role_settings.rb +2 -0
  12. data/lib/docusign_esign/models/account_settings_information.rb +205 -3
  13. data/lib/docusign_esign/models/account_shared_access.rb +1 -1
  14. data/lib/docusign_esign/models/account_signature.rb +1 -1
  15. data/lib/docusign_esign/models/account_ui_settings.rb +2 -0
  16. data/lib/docusign_esign/models/agent.rb +13 -3
  17. data/lib/docusign_esign/models/approve.rb +2 -1
  18. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  19. data/lib/docusign_esign/models/brand.rb +1 -1
  20. data/lib/docusign_esign/models/bulk_envelope.rb +1 -1
  21. data/lib/docusign_esign/models/bulk_sending_copy.rb +13 -1
  22. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +12 -2
  23. data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +194 -0
  24. data/lib/docusign_esign/models/captive_recipient.rb +1 -1
  25. data/lib/docusign_esign/models/carbon_copy.rb +13 -3
  26. data/lib/docusign_esign/models/certified_delivery.rb +13 -3
  27. data/lib/docusign_esign/models/checkbox.rb +2 -1
  28. data/lib/docusign_esign/models/cloud_storage_provider.rb +1 -1
  29. data/lib/docusign_esign/models/comment_thread.rb +2 -1
  30. data/lib/docusign_esign/models/commission_county.rb +2 -1
  31. data/lib/docusign_esign/models/commission_expiration.rb +2 -1
  32. data/lib/docusign_esign/models/commission_number.rb +2 -1
  33. data/lib/docusign_esign/models/commission_state.rb +2 -1
  34. data/lib/docusign_esign/models/company.rb +2 -1
  35. data/lib/docusign_esign/models/connect_custom_configuration.rb +11 -1
  36. data/lib/docusign_esign/models/connect_debug_log.rb +1 -1
  37. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +1 -0
  38. data/lib/docusign_esign/models/contact.rb +12 -2
  39. data/lib/docusign_esign/models/custom_field.rb +1 -1
  40. data/lib/docusign_esign/models/date.rb +2 -1
  41. data/lib/docusign_esign/models/date_signed.rb +2 -1
  42. data/lib/docusign_esign/models/decline.rb +2 -1
  43. data/lib/docusign_esign/models/delayed_routing.rb +1 -1
  44. data/lib/docusign_esign/models/doc_gen_form_field_request.rb +186 -0
  45. data/lib/docusign_esign/models/doc_gen_form_field_response.rb +196 -0
  46. data/lib/docusign_esign/models/doc_gen_form_fields.rb +218 -0
  47. data/lib/docusign_esign/models/document_template.rb +1 -1
  48. data/lib/docusign_esign/models/document_visibility.rb +1 -1
  49. data/lib/docusign_esign/models/draw.rb +2 -1
  50. data/lib/docusign_esign/models/editor.rb +13 -3
  51. data/lib/docusign_esign/models/email.rb +2 -1
  52. data/lib/docusign_esign/models/email_address.rb +2 -1
  53. data/lib/docusign_esign/models/envelope.rb +13 -3
  54. data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
  55. data/lib/docusign_esign/models/envelope_definition.rb +13 -3
  56. data/lib/docusign_esign/models/envelope_document.rb +1 -1
  57. data/lib/docusign_esign/models/envelope_id.rb +2 -1
  58. data/lib/docusign_esign/models/envelope_publish_transaction.rb +1 -0
  59. data/lib/docusign_esign/models/envelope_summary.rb +1 -1
  60. data/lib/docusign_esign/models/envelope_template.rb +13 -3
  61. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -1
  62. data/lib/docusign_esign/models/envelope_update_summary.rb +1 -1
  63. data/lib/docusign_esign/models/event_notification.rb +11 -1
  64. data/lib/docusign_esign/models/external_folder.rb +1 -1
  65. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -1
  66. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -1
  67. data/lib/docusign_esign/models/first_name.rb +2 -1
  68. data/lib/docusign_esign/models/folder.rb +1 -1
  69. data/lib/docusign_esign/models/folder_item_v2.rb +1 -1
  70. data/lib/docusign_esign/models/folder_shared_item.rb +1 -1
  71. data/lib/docusign_esign/models/form_data_item.rb +12 -2
  72. data/lib/docusign_esign/models/formula_tab.rb +2 -1
  73. data/lib/docusign_esign/models/full_name.rb +2 -1
  74. data/lib/docusign_esign/models/group.rb +1 -1
  75. data/lib/docusign_esign/models/id_evidence_view_link.rb +3 -3
  76. data/lib/docusign_esign/models/in_person_signer.rb +13 -3
  77. data/lib/docusign_esign/models/initial_here.rb +3 -2
  78. data/lib/docusign_esign/models/inline_template.rb +2 -2
  79. data/lib/docusign_esign/models/intermediary.rb +13 -3
  80. data/lib/docusign_esign/models/jurisdiction_summary.rb +214 -0
  81. data/lib/docusign_esign/models/last_name.rb +2 -1
  82. data/lib/docusign_esign/models/list.rb +2 -1
  83. data/lib/docusign_esign/models/list_custom_field.rb +1 -1
  84. data/lib/docusign_esign/models/locale_policy_tab.rb +14 -4
  85. data/lib/docusign_esign/models/lock_information.rb +1 -1
  86. data/lib/docusign_esign/models/member_group_shared_item.rb +1 -1
  87. data/lib/docusign_esign/models/member_shared_items.rb +1 -1
  88. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -1
  89. data/lib/docusign_esign/models/name_value.rb +1 -1
  90. data/lib/docusign_esign/models/new_account_definition.rb +2 -2
  91. data/lib/docusign_esign/models/new_user.rb +1 -1
  92. data/lib/docusign_esign/models/notarize.rb +2 -1
  93. data/lib/docusign_esign/models/notary_contact_details.rb +196 -0
  94. data/lib/docusign_esign/models/notary_host.rb +13 -3
  95. data/lib/docusign_esign/models/notary_jurisdiction.rb +1 -1
  96. data/lib/docusign_esign/models/notary_recipient.rb +13 -3
  97. data/lib/docusign_esign/models/notary_seal.rb +2 -1
  98. data/lib/docusign_esign/models/note.rb +2 -1
  99. data/lib/docusign_esign/models/number.rb +2 -1
  100. data/lib/docusign_esign/models/numerical.rb +1346 -0
  101. data/lib/docusign_esign/models/page.rb +1 -1
  102. data/lib/docusign_esign/models/participant.rb +33 -1
  103. data/lib/docusign_esign/models/phone_number.rb +2 -1
  104. data/lib/docusign_esign/models/poly_line_overlay.rb +2 -1
  105. data/lib/docusign_esign/models/power_form.rb +1 -1
  106. data/lib/docusign_esign/models/radio.rb +13 -2
  107. data/lib/docusign_esign/models/recipient_identity_verification.rb +14 -4
  108. data/lib/docusign_esign/models/recipient_update_response.rb +1 -1
  109. data/lib/docusign_esign/models/recipients.rb +1 -1
  110. data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
  111. data/lib/docusign_esign/models/seal_sign.rb +13 -3
  112. data/lib/docusign_esign/models/sender_company.rb +2 -1
  113. data/lib/docusign_esign/models/sender_name.rb +2 -1
  114. data/lib/docusign_esign/models/shared_item.rb +1 -1
  115. data/lib/docusign_esign/models/sign_here.rb +2 -1
  116. data/lib/docusign_esign/models/signer.rb +13 -3
  117. data/lib/docusign_esign/models/signer_attachment.rb +2 -1
  118. data/lib/docusign_esign/models/signing_group.rb +1 -1
  119. data/lib/docusign_esign/models/signing_group_user.rb +1 -1
  120. data/lib/docusign_esign/models/smart_section.rb +4 -3
  121. data/lib/docusign_esign/models/social_account_information.rb +1 -1
  122. data/lib/docusign_esign/models/ssn.rb +2 -1
  123. data/lib/docusign_esign/models/stamp.rb +1 -1
  124. data/lib/docusign_esign/models/tab_account_settings.rb +21 -21
  125. data/lib/docusign_esign/models/tab_group.rb +2 -1
  126. data/lib/docusign_esign/models/tab_metadata.rb +11 -1
  127. data/lib/docusign_esign/models/tabs.rb +13 -13
  128. data/lib/docusign_esign/models/template_recipients.rb +1 -1
  129. data/lib/docusign_esign/models/template_role.rb +12 -2
  130. data/lib/docusign_esign/models/template_shared_item.rb +1 -1
  131. data/lib/docusign_esign/models/template_summary.rb +1 -1
  132. data/lib/docusign_esign/models/template_tabs.rb +13 -13
  133. data/lib/docusign_esign/models/template_update_summary.rb +1 -1
  134. data/lib/docusign_esign/models/text.rb +2 -1
  135. data/lib/docusign_esign/models/text_custom_field.rb +1 -1
  136. data/lib/docusign_esign/models/title.rb +2 -1
  137. data/lib/docusign_esign/models/user_account_management_granular_information.rb +22 -1
  138. data/lib/docusign_esign/models/user_info.rb +12 -2
  139. data/lib/docusign_esign/models/user_information.rb +2 -2
  140. data/lib/docusign_esign/models/user_settings_information.rb +2 -0
  141. data/lib/docusign_esign/models/user_shared_item.rb +1 -1
  142. data/lib/docusign_esign/models/user_signature.rb +1 -1
  143. data/lib/docusign_esign/models/view.rb +2 -1
  144. data/lib/docusign_esign/models/witness.rb +13 -3
  145. data/lib/docusign_esign/models/workspace_user.rb +1 -1
  146. data/lib/docusign_esign/models/workspace_user_authorization.rb +1 -1
  147. data/lib/docusign_esign/models/zip.rb +2 -1
  148. data/lib/docusign_esign/version.rb +1 -1
  149. data/lib/docusign_esign.rb +7 -6
  150. metadata +9 -2
@@ -0,0 +1,196 @@
1
+ =begin
2
+ #DocuSign REST API
3
+
4
+ #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
+
6
+ OpenAPI spec version: v2.1
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module DocuSign_eSign
15
+ class DocGenFormFieldResponse
16
+ #
17
+ attr_accessor :doc_gen_form_fields
18
+
19
+ # Array or errors.
20
+ attr_accessor :error_details
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'doc_gen_form_fields' => :'docGenFormFields',
26
+ :'error_details' => :'errorDetails'
27
+ }
28
+ end
29
+
30
+ # Attribute type mapping.
31
+ def self.swagger_types
32
+ {
33
+ :'doc_gen_form_fields' => :'Array<DocGenFormFields>',
34
+ :'error_details' => :'ErrorDetails'
35
+ }
36
+ end
37
+
38
+ # Initializes the object
39
+ # @param [Hash] attributes Model attributes in the form of hash
40
+ def initialize(attributes = {})
41
+ return unless attributes.is_a?(Hash)
42
+
43
+ # convert string to symbol for hash key
44
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
45
+
46
+ if attributes.has_key?(:'docGenFormFields')
47
+ if (value = attributes[:'docGenFormFields']).is_a?(Array)
48
+ self.doc_gen_form_fields = value
49
+ end
50
+ end
51
+
52
+ if attributes.has_key?(:'errorDetails')
53
+ self.error_details = attributes[:'errorDetails']
54
+ end
55
+ end
56
+
57
+ # Show invalid properties with the reasons. Usually used together with valid?
58
+ # @return Array for valid properties with the reasons
59
+ def list_invalid_properties
60
+ invalid_properties = Array.new
61
+ invalid_properties
62
+ end
63
+
64
+ # Check to see if the all the properties in the model are valid
65
+ # @return true if the model is valid
66
+ def valid?
67
+ true
68
+ end
69
+
70
+ # Checks equality by comparing each attribute.
71
+ # @param [Object] Object to be compared
72
+ def ==(o)
73
+ return true if self.equal?(o)
74
+ self.class == o.class &&
75
+ doc_gen_form_fields == o.doc_gen_form_fields &&
76
+ error_details == o.error_details
77
+ end
78
+
79
+ # @see the `==` method
80
+ # @param [Object] Object to be compared
81
+ def eql?(o)
82
+ self == o
83
+ end
84
+
85
+ # Calculates hash code according to all attributes.
86
+ # @return [Fixnum] Hash code
87
+ def hash
88
+ [doc_gen_form_fields, error_details].hash
89
+ end
90
+
91
+ # Builds the object from hash
92
+ # @param [Hash] attributes Model attributes in the form of hash
93
+ # @return [Object] Returns the model itself
94
+ def build_from_hash(attributes)
95
+ return nil unless attributes.is_a?(Hash)
96
+ self.class.swagger_types.each_pair do |key, type|
97
+ if type =~ /\AArray<(.*)>/i
98
+ # check to ensure the input is an array given that the attribute
99
+ # is documented as an array but the input is not
100
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
101
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
102
+ end
103
+ elsif !attributes[self.class.attribute_map[key]].nil?
104
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
105
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
106
+ end
107
+
108
+ self
109
+ end
110
+
111
+ # Deserializes the data based on type
112
+ # @param string type Data type
113
+ # @param string value Value to be deserialized
114
+ # @return [Object] Deserialized data
115
+ def _deserialize(type, value)
116
+ case type.to_sym
117
+ when :DateTime
118
+ DateTime.parse(value)
119
+ when :Date
120
+ Date.parse(value)
121
+ when :String
122
+ value.to_s
123
+ when :Integer
124
+ value.to_i
125
+ when :Float
126
+ value.to_f
127
+ when :BOOLEAN
128
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
129
+ true
130
+ else
131
+ false
132
+ end
133
+ when :Object
134
+ # generic object (usually a Hash), return directly
135
+ value
136
+ when /\AArray<(?<inner_type>.+)>\z/
137
+ inner_type = Regexp.last_match[:inner_type]
138
+ value.map { |v| _deserialize(inner_type, v) }
139
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
140
+ k_type = Regexp.last_match[:k_type]
141
+ v_type = Regexp.last_match[:v_type]
142
+ {}.tap do |hash|
143
+ value.each do |k, v|
144
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
145
+ end
146
+ end
147
+ else # model
148
+ temp_model = DocuSign_eSign.const_get(type).new
149
+ temp_model.build_from_hash(value)
150
+ end
151
+ end
152
+
153
+ # Returns the string representation of the object
154
+ # @return [String] String presentation of the object
155
+ def to_s
156
+ to_hash.to_s
157
+ end
158
+
159
+ # to_body is an alias to to_hash (backward compatibility)
160
+ # @return [Hash] Returns the object in the form of hash
161
+ def to_body
162
+ to_hash
163
+ end
164
+
165
+ # Returns the object in the form of hash
166
+ # @return [Hash] Returns the object in the form of hash
167
+ def to_hash
168
+ hash = {}
169
+ self.class.attribute_map.each_pair do |attr, param|
170
+ value = self.send(attr)
171
+ next if value.nil?
172
+ hash[param] = _to_hash(value)
173
+ end
174
+ hash
175
+ end
176
+
177
+ # Outputs non-array value in the form of hash
178
+ # For object, use to_hash. Otherwise, just return the value
179
+ # @param [Object] value Any valid value
180
+ # @return [Hash] Returns the value in the form of hash
181
+ def _to_hash(value)
182
+ if value.is_a?(Array)
183
+ value.compact.map { |v| _to_hash(v) }
184
+ elsif value.is_a?(Hash)
185
+ {}.tap do |hash|
186
+ value.each { |k, v| hash[k] = _to_hash(v) }
187
+ end
188
+ elsif value.respond_to? :to_hash
189
+ value.to_hash
190
+ else
191
+ value
192
+ end
193
+ end
194
+
195
+ end
196
+ end
@@ -0,0 +1,218 @@
1
+ =begin
2
+ #DocuSign REST API
3
+
4
+ #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
+
6
+ OpenAPI spec version: v2.1
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module DocuSign_eSign
15
+ class DocGenFormFields
16
+ #
17
+ attr_accessor :doc_gen_document_status
18
+
19
+ #
20
+ attr_accessor :doc_gen_errors
21
+
22
+ #
23
+ attr_accessor :doc_gen_form_field_list
24
+
25
+ # Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
26
+ attr_accessor :document_id
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'doc_gen_document_status' => :'docGenDocumentStatus',
32
+ :'doc_gen_errors' => :'docGenErrors',
33
+ :'doc_gen_form_field_list' => :'docGenFormFieldList',
34
+ :'document_id' => :'documentId'
35
+ }
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.swagger_types
40
+ {
41
+ :'doc_gen_document_status' => :'String',
42
+ :'doc_gen_errors' => :'Array<DocGenSyntaxError>',
43
+ :'doc_gen_form_field_list' => :'Array<DocGenFormField>',
44
+ :'document_id' => :'String'
45
+ }
46
+ end
47
+
48
+ # Initializes the object
49
+ # @param [Hash] attributes Model attributes in the form of hash
50
+ def initialize(attributes = {})
51
+ return unless attributes.is_a?(Hash)
52
+
53
+ # convert string to symbol for hash key
54
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
55
+
56
+ if attributes.has_key?(:'docGenDocumentStatus')
57
+ self.doc_gen_document_status = attributes[:'docGenDocumentStatus']
58
+ end
59
+
60
+ if attributes.has_key?(:'docGenErrors')
61
+ if (value = attributes[:'docGenErrors']).is_a?(Array)
62
+ self.doc_gen_errors = value
63
+ end
64
+ end
65
+
66
+ if attributes.has_key?(:'docGenFormFieldList')
67
+ if (value = attributes[:'docGenFormFieldList']).is_a?(Array)
68
+ self.doc_gen_form_field_list = value
69
+ end
70
+ end
71
+
72
+ if attributes.has_key?(:'documentId')
73
+ self.document_id = attributes[:'documentId']
74
+ end
75
+ end
76
+
77
+ # Show invalid properties with the reasons. Usually used together with valid?
78
+ # @return Array for valid properties with the reasons
79
+ def list_invalid_properties
80
+ invalid_properties = Array.new
81
+ invalid_properties
82
+ end
83
+
84
+ # Check to see if the all the properties in the model are valid
85
+ # @return true if the model is valid
86
+ def valid?
87
+ true
88
+ end
89
+
90
+ # Checks equality by comparing each attribute.
91
+ # @param [Object] Object to be compared
92
+ def ==(o)
93
+ return true if self.equal?(o)
94
+ self.class == o.class &&
95
+ doc_gen_document_status == o.doc_gen_document_status &&
96
+ doc_gen_errors == o.doc_gen_errors &&
97
+ doc_gen_form_field_list == o.doc_gen_form_field_list &&
98
+ document_id == o.document_id
99
+ end
100
+
101
+ # @see the `==` method
102
+ # @param [Object] Object to be compared
103
+ def eql?(o)
104
+ self == o
105
+ end
106
+
107
+ # Calculates hash code according to all attributes.
108
+ # @return [Fixnum] Hash code
109
+ def hash
110
+ [doc_gen_document_status, doc_gen_errors, doc_gen_form_field_list, document_id].hash
111
+ end
112
+
113
+ # Builds the object from hash
114
+ # @param [Hash] attributes Model attributes in the form of hash
115
+ # @return [Object] Returns the model itself
116
+ def build_from_hash(attributes)
117
+ return nil unless attributes.is_a?(Hash)
118
+ self.class.swagger_types.each_pair do |key, type|
119
+ if type =~ /\AArray<(.*)>/i
120
+ # check to ensure the input is an array given that the attribute
121
+ # is documented as an array but the input is not
122
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
123
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
124
+ end
125
+ elsif !attributes[self.class.attribute_map[key]].nil?
126
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
127
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
128
+ end
129
+
130
+ self
131
+ end
132
+
133
+ # Deserializes the data based on type
134
+ # @param string type Data type
135
+ # @param string value Value to be deserialized
136
+ # @return [Object] Deserialized data
137
+ def _deserialize(type, value)
138
+ case type.to_sym
139
+ when :DateTime
140
+ DateTime.parse(value)
141
+ when :Date
142
+ Date.parse(value)
143
+ when :String
144
+ value.to_s
145
+ when :Integer
146
+ value.to_i
147
+ when :Float
148
+ value.to_f
149
+ when :BOOLEAN
150
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
151
+ true
152
+ else
153
+ false
154
+ end
155
+ when :Object
156
+ # generic object (usually a Hash), return directly
157
+ value
158
+ when /\AArray<(?<inner_type>.+)>\z/
159
+ inner_type = Regexp.last_match[:inner_type]
160
+ value.map { |v| _deserialize(inner_type, v) }
161
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
162
+ k_type = Regexp.last_match[:k_type]
163
+ v_type = Regexp.last_match[:v_type]
164
+ {}.tap do |hash|
165
+ value.each do |k, v|
166
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
167
+ end
168
+ end
169
+ else # model
170
+ temp_model = DocuSign_eSign.const_get(type).new
171
+ temp_model.build_from_hash(value)
172
+ end
173
+ end
174
+
175
+ # Returns the string representation of the object
176
+ # @return [String] String presentation of the object
177
+ def to_s
178
+ to_hash.to_s
179
+ end
180
+
181
+ # to_body is an alias to to_hash (backward compatibility)
182
+ # @return [Hash] Returns the object in the form of hash
183
+ def to_body
184
+ to_hash
185
+ end
186
+
187
+ # Returns the object in the form of hash
188
+ # @return [Hash] Returns the object in the form of hash
189
+ def to_hash
190
+ hash = {}
191
+ self.class.attribute_map.each_pair do |attr, param|
192
+ value = self.send(attr)
193
+ next if value.nil?
194
+ hash[param] = _to_hash(value)
195
+ end
196
+ hash
197
+ end
198
+
199
+ # Outputs non-array value in the form of hash
200
+ # For object, use to_hash. Otherwise, just return the value
201
+ # @param [Object] value Any valid value
202
+ # @return [Hash] Returns the value in the form of hash
203
+ def _to_hash(value)
204
+ if value.is_a?(Array)
205
+ value.compact.map { |v| _to_hash(v) }
206
+ elsif value.is_a?(Hash)
207
+ {}.tap do |hash|
208
+ value.each { |k, v| hash[k] = _to_hash(v) }
209
+ end
210
+ elsif value.respond_to? :to_hash
211
+ value.to_hash
212
+ else
213
+ value
214
+ end
215
+ end
216
+
217
+ end
218
+ end
@@ -22,7 +22,7 @@ module DocuSign_eSign
22
22
  #
23
23
  attr_accessor :document_start_page
24
24
 
25
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
25
+ # Array or errors.
26
26
  attr_accessor :error_details
27
27
 
28
28
  # The unique identifier of the template. If this is not provided, DocuSign will generate a value.
@@ -17,7 +17,7 @@ module DocuSign_eSign
17
17
  # Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
18
18
  attr_accessor :document_id
19
19
 
20
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
20
+ # Array or errors.
21
21
  attr_accessor :error_details
22
22
 
23
23
  # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -80,6 +80,7 @@ module DocuSign_eSign
80
80
  #
81
81
  attr_accessor :caption
82
82
 
83
+ #
83
84
  attr_accessor :caption_metadata
84
85
 
85
86
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -106,7 +107,7 @@ module DocuSign_eSign
106
107
  # Metadata that indicates whether the `documentId` property is editable.
107
108
  attr_accessor :document_id_metadata
108
109
 
109
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
110
+ # Array or errors.
110
111
  attr_accessor :error_details
111
112
 
112
113
  #
@@ -32,6 +32,9 @@ module DocuSign_eSign
32
32
  #
33
33
  attr_accessor :auto_responded_reason
34
34
 
35
+ #
36
+ attr_accessor :bulk_send_v2_recipient
37
+
35
38
  # Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters.
36
39
  attr_accessor :client_user_id
37
40
 
@@ -74,7 +77,7 @@ module DocuSign_eSign
74
77
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
75
78
  attr_accessor :email_metadata
76
79
 
77
- # An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
80
+ # A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings.
78
81
  attr_accessor :email_notification
79
82
 
80
83
  #
@@ -83,7 +86,7 @@ module DocuSign_eSign
83
86
  # Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
84
87
  attr_accessor :embedded_recipient_start_url
85
88
 
86
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
89
+ # Array or errors.
87
90
  attr_accessor :error_details
88
91
 
89
92
  # Reserved:
@@ -239,6 +242,7 @@ module DocuSign_eSign
239
242
  :'additional_notifications' => :'additionalNotifications',
240
243
  :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
241
244
  :'auto_responded_reason' => :'autoRespondedReason',
245
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
242
246
  :'client_user_id' => :'clientUserId',
243
247
  :'completed_count' => :'completedCount',
244
248
  :'consent_details_list' => :'consentDetailsList',
@@ -317,6 +321,7 @@ module DocuSign_eSign
317
321
  :'additional_notifications' => :'Array<RecipientAdditionalNotification>',
318
322
  :'allow_system_override_for_locked_recipient' => :'String',
319
323
  :'auto_responded_reason' => :'String',
324
+ :'bulk_send_v2_recipient' => :'String',
320
325
  :'client_user_id' => :'String',
321
326
  :'completed_count' => :'String',
322
327
  :'consent_details_list' => :'Array<ConsentDetails>',
@@ -420,6 +425,10 @@ module DocuSign_eSign
420
425
  self.auto_responded_reason = attributes[:'autoRespondedReason']
421
426
  end
422
427
 
428
+ if attributes.has_key?(:'bulkSendV2Recipient')
429
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
430
+ end
431
+
423
432
  if attributes.has_key?(:'clientUserId')
424
433
  self.client_user_id = attributes[:'clientUserId']
425
434
  end
@@ -723,6 +732,7 @@ module DocuSign_eSign
723
732
  additional_notifications == o.additional_notifications &&
724
733
  allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
725
734
  auto_responded_reason == o.auto_responded_reason &&
735
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
726
736
  client_user_id == o.client_user_id &&
727
737
  completed_count == o.completed_count &&
728
738
  consent_details_list == o.consent_details_list &&
@@ -800,7 +810,7 @@ module DocuSign_eSign
800
810
  # Calculates hash code according to all attributes.
801
811
  # @return [Fixnum] Hash code
802
812
  def hash
803
- [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
813
+ [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, bulk_send_v2_recipient, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
804
814
  end
805
815
 
806
816
  # Builds the object from hash
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
@@ -121,7 +122,7 @@ module DocuSign_eSign
121
122
  # Metadata that indicates whether the `documentId` property is editable.
122
123
  attr_accessor :document_id_metadata
123
124
 
124
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
125
+ # Array or errors.
125
126
  attr_accessor :error_details
126
127
 
127
128
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
109
110
  # Metadata that indicates whether the `documentId` property is editable.
110
111
  attr_accessor :document_id_metadata
111
112
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
113
+ # Array or errors.
113
114
  attr_accessor :error_details
114
115
 
115
116
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -52,6 +52,9 @@ module DocuSign_eSign
52
52
  #
53
53
  attr_accessor :brand_lock
54
54
 
55
+ #
56
+ attr_accessor :burn_default_tab_data
57
+
55
58
  # Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
56
59
  attr_accessor :certificate_uri
57
60
 
@@ -64,7 +67,7 @@ module DocuSign_eSign
64
67
  # Indicates the date and time the item was created.
65
68
  attr_accessor :created_date_time
66
69
 
67
- # An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters.
70
+ # An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
68
71
  attr_accessor :custom_fields
69
72
 
70
73
  # Contains a URI for an endpoint that you can use to retrieve the custom fields.
@@ -199,7 +202,7 @@ module DocuSign_eSign
199
202
  #
200
203
  attr_accessor :purge_state
201
204
 
202
- # An array of recipient objects that provides details about the recipients of the envelope.
205
+ # An array of powerform recipients.
203
206
  attr_accessor :recipients
204
207
 
205
208
  # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
@@ -263,6 +266,7 @@ module DocuSign_eSign
263
266
  :'auto_navigation' => :'autoNavigation',
264
267
  :'brand_id' => :'brandId',
265
268
  :'brand_lock' => :'brandLock',
269
+ :'burn_default_tab_data' => :'burnDefaultTabData',
266
270
  :'certificate_uri' => :'certificateUri',
267
271
  :'completed_date_time' => :'completedDateTime',
268
272
  :'copy_recipient_data' => :'copyRecipientData',
@@ -347,6 +351,7 @@ module DocuSign_eSign
347
351
  :'auto_navigation' => :'String',
348
352
  :'brand_id' => :'String',
349
353
  :'brand_lock' => :'String',
354
+ :'burn_default_tab_data' => :'String',
350
355
  :'certificate_uri' => :'String',
351
356
  :'completed_date_time' => :'String',
352
357
  :'copy_recipient_data' => :'String',
@@ -475,6 +480,10 @@ module DocuSign_eSign
475
480
  self.brand_lock = attributes[:'brandLock']
476
481
  end
477
482
 
483
+ if attributes.has_key?(:'burnDefaultTabData')
484
+ self.burn_default_tab_data = attributes[:'burnDefaultTabData']
485
+ end
486
+
478
487
  if attributes.has_key?(:'certificateUri')
479
488
  self.certificate_uri = attributes[:'certificateUri']
480
489
  end
@@ -773,6 +782,7 @@ module DocuSign_eSign
773
782
  auto_navigation == o.auto_navigation &&
774
783
  brand_id == o.brand_id &&
775
784
  brand_lock == o.brand_lock &&
785
+ burn_default_tab_data == o.burn_default_tab_data &&
776
786
  certificate_uri == o.certificate_uri &&
777
787
  completed_date_time == o.completed_date_time &&
778
788
  copy_recipient_data == o.copy_recipient_data &&
@@ -849,7 +859,7 @@ module DocuSign_eSign
849
859
  # Calculates hash code according to all attributes.
850
860
  # @return [Fixnum] Hash code
851
861
  def hash
852
- [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, document_base64, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_custom_metadata, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified_date_time, location, lock_information, message_lock, notification, notification_uri, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
862
+ [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, burn_default_tab_data, certificate_uri, completed_date_time, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, document_base64, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_custom_metadata, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified_date_time, location, lock_information, message_lock, notification, notification_uri, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
853
863
  end
854
864
 
855
865
  # Builds the object from hash
@@ -22,7 +22,7 @@ module DocuSign_eSign
22
22
  #
23
23
  attr_accessor :attachment_type
24
24
 
25
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
25
+ # Array or errors.
26
26
  attr_accessor :error_details
27
27
 
28
28
  #