docusign_esign 3.0.0 → 3.1.0.pre.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +2 -2
  3. data/lib/docusign_esign.rb +464 -447
  4. data/{tests → lib/docusign_esign/api}/.DS_Store +0 -0
  5. data/lib/docusign_esign/api/accounts_api.rb +69 -8
  6. data/lib/docusign_esign/api/authentication_api.rb +8 -8
  7. data/lib/docusign_esign/api/bulk_envelopes_api.rb +335 -0
  8. data/lib/docusign_esign/api/connect_api.rb +400 -0
  9. data/lib/docusign_esign/api/envelopes_api.rb +77 -588
  10. data/lib/docusign_esign/api/notary_api.rb +439 -0
  11. data/lib/docusign_esign/api/organizations_api.rb +232 -0
  12. data/lib/docusign_esign/api/tsps_api.rb +256 -0
  13. data/lib/docusign_esign/models/account_settings_information.rb +125 -10
  14. data/lib/docusign_esign/models/account_ui_settings.rb +60 -4
  15. data/lib/docusign_esign/models/admin_message.rb +198 -0
  16. data/lib/docusign_esign/models/agent.rb +21 -1
  17. data/lib/docusign_esign/models/approve.rb +29 -1
  18. data/lib/docusign_esign/models/ask_an_admin.rb +218 -0
  19. data/lib/docusign_esign/models/carbon_copy.rb +39 -1
  20. data/lib/docusign_esign/models/certified_delivery.rb +39 -1
  21. data/lib/docusign_esign/models/checkbox.rb +29 -1
  22. data/lib/docusign_esign/models/comment_thread.rb +29 -1
  23. data/lib/docusign_esign/models/company.rb +29 -1
  24. data/lib/docusign_esign/models/complete_sign_request.rb +22 -2
  25. data/lib/docusign_esign/models/connect_custom_configuration.rb +19 -19
  26. data/lib/docusign_esign/models/credential.rb +12 -2
  27. data/lib/docusign_esign/models/date.rb +29 -1
  28. data/lib/docusign_esign/models/date_signed.rb +29 -1
  29. data/lib/docusign_esign/models/decline.rb +29 -1
  30. data/lib/docusign_esign/models/document.rb +53 -1
  31. data/lib/docusign_esign/models/document_fields_information.rb +1 -1
  32. data/lib/docusign_esign/models/document_html_display_settings.rb +11 -1
  33. data/lib/docusign_esign/models/document_security_store.rb +1 -1
  34. data/lib/docusign_esign/models/document_update_info.rb +1 -1
  35. data/lib/docusign_esign/models/editor.rb +21 -1
  36. data/lib/docusign_esign/models/email.rb +29 -1
  37. data/lib/docusign_esign/models/email_address.rb +29 -1
  38. data/lib/docusign_esign/models/envelope_document.rb +11 -1
  39. data/lib/docusign_esign/models/envelope_id.rb +29 -1
  40. data/lib/docusign_esign/models/envelope_template.rb +1 -11
  41. data/lib/docusign_esign/models/first_name.rb +29 -1
  42. data/lib/docusign_esign/models/formula_tab.rb +29 -1
  43. data/lib/docusign_esign/models/full_name.rb +29 -1
  44. data/lib/docusign_esign/models/in_person_signer.rb +21 -1
  45. data/lib/docusign_esign/models/initial_here.rb +29 -1
  46. data/lib/docusign_esign/models/intermediary.rb +21 -1
  47. data/lib/docusign_esign/models/last_name.rb +29 -1
  48. data/lib/docusign_esign/models/list.rb +29 -1
  49. data/lib/docusign_esign/models/notarize.rb +29 -1
  50. data/lib/docusign_esign/models/notary.rb +217 -0
  51. data/lib/docusign_esign/models/notary_host.rb +21 -1
  52. data/lib/docusign_esign/models/notary_jurisdiction.rb +246 -0
  53. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +250 -0
  54. data/lib/docusign_esign/models/notary_result.rb +199 -0
  55. data/lib/docusign_esign/models/note.rb +29 -1
  56. data/lib/docusign_esign/models/number.rb +29 -1
  57. data/lib/docusign_esign/models/ocr_request.rb +238 -0
  58. data/lib/docusign_esign/models/offline_attributes.rb +238 -0
  59. data/lib/docusign_esign/models/poly_line_overlay.rb +29 -1
  60. data/lib/docusign_esign/models/proof_service_resource_token.rb +188 -0
  61. data/lib/docusign_esign/models/proof_service_view_link.rb +188 -0
  62. data/lib/docusign_esign/models/radio.rb +20 -1
  63. data/lib/docusign_esign/models/recipient_email_notification.rb +1 -1
  64. data/lib/docusign_esign/models/recipient_proof_file.rb +188 -0
  65. data/lib/docusign_esign/models/revision.rb +11 -2
  66. data/lib/docusign_esign/models/seal_sign.rb +21 -1
  67. data/lib/docusign_esign/models/sender.rb +1 -1
  68. data/lib/docusign_esign/models/sign_hash_document.rb +12 -3
  69. data/lib/docusign_esign/models/sign_hash_session_info_response.rb +12 -3
  70. data/lib/docusign_esign/models/sign_here.rb +38 -1
  71. data/lib/docusign_esign/models/sign_session_info_request.rb +12 -2
  72. data/lib/docusign_esign/models/signature_data_info.rb +1 -1
  73. data/lib/docusign_esign/models/signer.rb +31 -2
  74. data/lib/docusign_esign/models/signer_attachment.rb +29 -1
  75. data/lib/docusign_esign/models/smart_contract_information.rb +198 -0
  76. data/lib/docusign_esign/models/smart_section.rb +29 -1
  77. data/lib/docusign_esign/models/smart_section_display_settings.rb +11 -1
  78. data/lib/docusign_esign/models/ssn.rb +29 -1
  79. data/lib/docusign_esign/models/stamp.rb +336 -0
  80. data/lib/docusign_esign/models/tab_group.rb +29 -1
  81. data/lib/docusign_esign/models/text.rb +29 -1
  82. data/lib/docusign_esign/models/time_stamp_field.rb +1 -1
  83. data/lib/docusign_esign/models/title.rb +29 -1
  84. data/lib/docusign_esign/models/tsp_health_check_request.rb +1 -1
  85. data/lib/docusign_esign/models/tsp_health_check_status_description.rb +1 -1
  86. data/lib/docusign_esign/models/update_transaction_request.rb +1 -1
  87. data/lib/docusign_esign/models/update_transaction_response.rb +1 -1
  88. data/lib/docusign_esign/models/usage_history.rb +1 -1
  89. data/lib/docusign_esign/models/user.rb +27 -5
  90. data/lib/docusign_esign/models/user_info_response.rb +1 -1
  91. data/lib/docusign_esign/models/user_information.rb +1 -1
  92. data/lib/docusign_esign/models/user_signature.rb +14 -4
  93. data/lib/docusign_esign/models/view.rb +29 -1
  94. data/lib/docusign_esign/models/witness.rb +30 -1
  95. data/lib/docusign_esign/models/zip.rb +29 -1
  96. data/lib/docusign_esign/version.rb +1 -1
  97. data/tests/Gemfile.lock +1 -1
  98. metadata +20 -7
  99. data/Gemfile.lock +0 -73
  100. data/docusign_esign-2.1.0.gem +0 -0
@@ -0,0 +1,246 @@
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
+
16
+ class NotaryJurisdiction
17
+ #
18
+ attr_accessor :commission_expiration
19
+
20
+ #
21
+ attr_accessor :commission_id
22
+
23
+ #
24
+ attr_accessor :county
25
+
26
+ attr_accessor :error_details
27
+
28
+ attr_accessor :jurisdiction
29
+
30
+ #
31
+ attr_accessor :registered_name
32
+
33
+ #
34
+ attr_accessor :seal_type
35
+
36
+
37
+ # Attribute mapping from ruby-style variable name to JSON key.
38
+ def self.attribute_map
39
+ {
40
+ :'commission_expiration' => :'commissionExpiration',
41
+ :'commission_id' => :'commissionId',
42
+ :'county' => :'county',
43
+ :'error_details' => :'errorDetails',
44
+ :'jurisdiction' => :'jurisdiction',
45
+ :'registered_name' => :'registeredName',
46
+ :'seal_type' => :'sealType'
47
+ }
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.swagger_types
52
+ {
53
+ :'commission_expiration' => :'String',
54
+ :'commission_id' => :'String',
55
+ :'county' => :'String',
56
+ :'error_details' => :'ErrorDetails',
57
+ :'jurisdiction' => :'Jurisdiction',
58
+ :'registered_name' => :'String',
59
+ :'seal_type' => :'String'
60
+ }
61
+ end
62
+
63
+ # Initializes the object
64
+ # @param [Hash] attributes Model attributes in the form of hash
65
+ def initialize(attributes = {})
66
+ return unless attributes.is_a?(Hash)
67
+
68
+ # convert string to symbol for hash key
69
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
70
+
71
+ if attributes.has_key?(:'commissionExpiration')
72
+ self.commission_expiration = attributes[:'commissionExpiration']
73
+ end
74
+
75
+ if attributes.has_key?(:'commissionId')
76
+ self.commission_id = attributes[:'commissionId']
77
+ end
78
+
79
+ if attributes.has_key?(:'county')
80
+ self.county = attributes[:'county']
81
+ end
82
+
83
+ if attributes.has_key?(:'errorDetails')
84
+ self.error_details = attributes[:'errorDetails']
85
+ end
86
+
87
+ if attributes.has_key?(:'jurisdiction')
88
+ self.jurisdiction = attributes[:'jurisdiction']
89
+ end
90
+
91
+ if attributes.has_key?(:'registeredName')
92
+ self.registered_name = attributes[:'registeredName']
93
+ end
94
+
95
+ if attributes.has_key?(:'sealType')
96
+ self.seal_type = attributes[:'sealType']
97
+ end
98
+
99
+ end
100
+
101
+ # Show invalid properties with the reasons. Usually used together with valid?
102
+ # @return Array for valid properies with the reasons
103
+ def list_invalid_properties
104
+ invalid_properties = Array.new
105
+ return invalid_properties
106
+ end
107
+
108
+ # Check to see if the all the properties in the model are valid
109
+ # @return true if the model is valid
110
+ def valid?
111
+ return true
112
+ end
113
+
114
+ # Checks equality by comparing each attribute.
115
+ # @param [Object] Object to be compared
116
+ def ==(o)
117
+ return true if self.equal?(o)
118
+ self.class == o.class &&
119
+ commission_expiration == o.commission_expiration &&
120
+ commission_id == o.commission_id &&
121
+ county == o.county &&
122
+ error_details == o.error_details &&
123
+ jurisdiction == o.jurisdiction &&
124
+ registered_name == o.registered_name &&
125
+ seal_type == o.seal_type
126
+ end
127
+
128
+ # @see the `==` method
129
+ # @param [Object] Object to be compared
130
+ def eql?(o)
131
+ self == o
132
+ end
133
+
134
+ # Calculates hash code according to all attributes.
135
+ # @return [Fixnum] Hash code
136
+ def hash
137
+ [commission_expiration, commission_id, county, error_details, jurisdiction, registered_name, seal_type].hash
138
+ end
139
+
140
+ # Builds the object from hash
141
+ # @param [Hash] attributes Model attributes in the form of hash
142
+ # @return [Object] Returns the model itself
143
+ def build_from_hash(attributes)
144
+ return nil unless attributes.is_a?(Hash)
145
+ self.class.swagger_types.each_pair do |key, type|
146
+ if type =~ /\AArray<(.*)>/i
147
+ # check to ensure the input is an array given that the the attribute
148
+ # is documented as an array but the input is not
149
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
150
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
151
+ end
152
+ elsif !attributes[self.class.attribute_map[key]].nil?
153
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
154
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
155
+ end
156
+
157
+ self
158
+ end
159
+
160
+ # Deserializes the data based on type
161
+ # @param string type Data type
162
+ # @param string value Value to be deserialized
163
+ # @return [Object] Deserialized data
164
+ def _deserialize(type, value)
165
+ case type.to_sym
166
+ when :DateTime
167
+ DateTime.parse(value)
168
+ when :Date
169
+ Date.parse(value)
170
+ when :String
171
+ value.to_s
172
+ when :Integer
173
+ value.to_i
174
+ when :Float
175
+ value.to_f
176
+ when :BOOLEAN
177
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
178
+ true
179
+ else
180
+ false
181
+ end
182
+ when :Object
183
+ # generic object (usually a Hash), return directly
184
+ value
185
+ when /\AArray<(?<inner_type>.+)>\z/
186
+ inner_type = Regexp.last_match[:inner_type]
187
+ value.map { |v| _deserialize(inner_type, v) }
188
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
189
+ k_type = Regexp.last_match[:k_type]
190
+ v_type = Regexp.last_match[:v_type]
191
+ {}.tap do |hash|
192
+ value.each do |k, v|
193
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
194
+ end
195
+ end
196
+ else # model
197
+ temp_model = DocuSign_eSign.const_get(type).new
198
+ temp_model.build_from_hash(value)
199
+ end
200
+ end
201
+
202
+ # Returns the string representation of the object
203
+ # @return [String] String presentation of the object
204
+ def to_s
205
+ to_hash.to_s
206
+ end
207
+
208
+ # to_body is an alias to to_hash (backward compatibility)
209
+ # @return [Hash] Returns the object in the form of hash
210
+ def to_body
211
+ to_hash
212
+ end
213
+
214
+ # Returns the object in the form of hash
215
+ # @return [Hash] Returns the object in the form of hash
216
+ def to_hash
217
+ hash = {}
218
+ self.class.attribute_map.each_pair do |attr, param|
219
+ value = self.send(attr)
220
+ next if value.nil?
221
+ hash[param] = _to_hash(value)
222
+ end
223
+ hash
224
+ end
225
+
226
+ # Outputs non-array value in the form of hash
227
+ # For object, use to_hash. Otherwise, just return the value
228
+ # @param [Object] value Any valid value
229
+ # @return [Hash] Returns the value in the form of hash
230
+ def _to_hash(value)
231
+ if value.is_a?(Array)
232
+ value.compact.map{ |v| _to_hash(v) }
233
+ elsif value.is_a?(Hash)
234
+ {}.tap do |hash|
235
+ value.each { |k, v| hash[k] = _to_hash(v) }
236
+ end
237
+ elsif value.respond_to? :to_hash
238
+ value.to_hash
239
+ else
240
+ value
241
+ end
242
+ end
243
+
244
+ end
245
+
246
+ end
@@ -0,0 +1,250 @@
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
+
16
+ class NotaryJurisdictionList
17
+ # The last position in the result set.
18
+ attr_accessor :end_position
19
+
20
+ # The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.
21
+ attr_accessor :next_uri
22
+
23
+ #
24
+ attr_accessor :notary_jurisdictions
25
+
26
+ # The postal code for the billing address.
27
+ attr_accessor :previous_uri
28
+
29
+ # The number of results returned in this response.
30
+ attr_accessor :result_set_size
31
+
32
+ # Starting position of the current result set.
33
+ attr_accessor :start_position
34
+
35
+ # The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.
36
+ attr_accessor :total_set_size
37
+
38
+
39
+ # Attribute mapping from ruby-style variable name to JSON key.
40
+ def self.attribute_map
41
+ {
42
+ :'end_position' => :'endPosition',
43
+ :'next_uri' => :'nextUri',
44
+ :'notary_jurisdictions' => :'notaryJurisdictions',
45
+ :'previous_uri' => :'previousUri',
46
+ :'result_set_size' => :'resultSetSize',
47
+ :'start_position' => :'startPosition',
48
+ :'total_set_size' => :'totalSetSize'
49
+ }
50
+ end
51
+
52
+ # Attribute type mapping.
53
+ def self.swagger_types
54
+ {
55
+ :'end_position' => :'String',
56
+ :'next_uri' => :'String',
57
+ :'notary_jurisdictions' => :'Array<NotaryJurisdiction>',
58
+ :'previous_uri' => :'String',
59
+ :'result_set_size' => :'String',
60
+ :'start_position' => :'String',
61
+ :'total_set_size' => :'String'
62
+ }
63
+ end
64
+
65
+ # Initializes the object
66
+ # @param [Hash] attributes Model attributes in the form of hash
67
+ def initialize(attributes = {})
68
+ return unless attributes.is_a?(Hash)
69
+
70
+ # convert string to symbol for hash key
71
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
72
+
73
+ if attributes.has_key?(:'endPosition')
74
+ self.end_position = attributes[:'endPosition']
75
+ end
76
+
77
+ if attributes.has_key?(:'nextUri')
78
+ self.next_uri = attributes[:'nextUri']
79
+ end
80
+
81
+ if attributes.has_key?(:'notaryJurisdictions')
82
+ if (value = attributes[:'notaryJurisdictions']).is_a?(Array)
83
+ self.notary_jurisdictions = value
84
+ end
85
+ end
86
+
87
+ if attributes.has_key?(:'previousUri')
88
+ self.previous_uri = attributes[:'previousUri']
89
+ end
90
+
91
+ if attributes.has_key?(:'resultSetSize')
92
+ self.result_set_size = attributes[:'resultSetSize']
93
+ end
94
+
95
+ if attributes.has_key?(:'startPosition')
96
+ self.start_position = attributes[:'startPosition']
97
+ end
98
+
99
+ if attributes.has_key?(:'totalSetSize')
100
+ self.total_set_size = attributes[:'totalSetSize']
101
+ end
102
+
103
+ end
104
+
105
+ # Show invalid properties with the reasons. Usually used together with valid?
106
+ # @return Array for valid properies with the reasons
107
+ def list_invalid_properties
108
+ invalid_properties = Array.new
109
+ return invalid_properties
110
+ end
111
+
112
+ # Check to see if the all the properties in the model are valid
113
+ # @return true if the model is valid
114
+ def valid?
115
+ return true
116
+ end
117
+
118
+ # Checks equality by comparing each attribute.
119
+ # @param [Object] Object to be compared
120
+ def ==(o)
121
+ return true if self.equal?(o)
122
+ self.class == o.class &&
123
+ end_position == o.end_position &&
124
+ next_uri == o.next_uri &&
125
+ notary_jurisdictions == o.notary_jurisdictions &&
126
+ previous_uri == o.previous_uri &&
127
+ result_set_size == o.result_set_size &&
128
+ start_position == o.start_position &&
129
+ total_set_size == o.total_set_size
130
+ end
131
+
132
+ # @see the `==` method
133
+ # @param [Object] Object to be compared
134
+ def eql?(o)
135
+ self == o
136
+ end
137
+
138
+ # Calculates hash code according to all attributes.
139
+ # @return [Fixnum] Hash code
140
+ def hash
141
+ [end_position, next_uri, notary_jurisdictions, previous_uri, result_set_size, start_position, total_set_size].hash
142
+ end
143
+
144
+ # Builds the object from hash
145
+ # @param [Hash] attributes Model attributes in the form of hash
146
+ # @return [Object] Returns the model itself
147
+ def build_from_hash(attributes)
148
+ return nil unless attributes.is_a?(Hash)
149
+ self.class.swagger_types.each_pair do |key, type|
150
+ if type =~ /\AArray<(.*)>/i
151
+ # check to ensure the input is an array given that the the attribute
152
+ # is documented as an array but the input is not
153
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
154
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
155
+ end
156
+ elsif !attributes[self.class.attribute_map[key]].nil?
157
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
158
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
159
+ end
160
+
161
+ self
162
+ end
163
+
164
+ # Deserializes the data based on type
165
+ # @param string type Data type
166
+ # @param string value Value to be deserialized
167
+ # @return [Object] Deserialized data
168
+ def _deserialize(type, value)
169
+ case type.to_sym
170
+ when :DateTime
171
+ DateTime.parse(value)
172
+ when :Date
173
+ Date.parse(value)
174
+ when :String
175
+ value.to_s
176
+ when :Integer
177
+ value.to_i
178
+ when :Float
179
+ value.to_f
180
+ when :BOOLEAN
181
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
182
+ true
183
+ else
184
+ false
185
+ end
186
+ when :Object
187
+ # generic object (usually a Hash), return directly
188
+ value
189
+ when /\AArray<(?<inner_type>.+)>\z/
190
+ inner_type = Regexp.last_match[:inner_type]
191
+ value.map { |v| _deserialize(inner_type, v) }
192
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
193
+ k_type = Regexp.last_match[:k_type]
194
+ v_type = Regexp.last_match[:v_type]
195
+ {}.tap do |hash|
196
+ value.each do |k, v|
197
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
198
+ end
199
+ end
200
+ else # model
201
+ temp_model = DocuSign_eSign.const_get(type).new
202
+ temp_model.build_from_hash(value)
203
+ end
204
+ end
205
+
206
+ # Returns the string representation of the object
207
+ # @return [String] String presentation of the object
208
+ def to_s
209
+ to_hash.to_s
210
+ end
211
+
212
+ # to_body is an alias to to_hash (backward compatibility)
213
+ # @return [Hash] Returns the object in the form of hash
214
+ def to_body
215
+ to_hash
216
+ end
217
+
218
+ # Returns the object in the form of hash
219
+ # @return [Hash] Returns the object in the form of hash
220
+ def to_hash
221
+ hash = {}
222
+ self.class.attribute_map.each_pair do |attr, param|
223
+ value = self.send(attr)
224
+ next if value.nil?
225
+ hash[param] = _to_hash(value)
226
+ end
227
+ hash
228
+ end
229
+
230
+ # Outputs non-array value in the form of hash
231
+ # For object, use to_hash. Otherwise, just return the value
232
+ # @param [Object] value Any valid value
233
+ # @return [Hash] Returns the value in the form of hash
234
+ def _to_hash(value)
235
+ if value.is_a?(Array)
236
+ value.compact.map{ |v| _to_hash(v) }
237
+ elsif value.is_a?(Hash)
238
+ {}.tap do |hash|
239
+ value.each { |k, v| hash[k] = _to_hash(v) }
240
+ end
241
+ elsif value.respond_to? :to_hash
242
+ value.to_hash
243
+ else
244
+ value
245
+ end
246
+ end
247
+
248
+ end
249
+
250
+ end