docusign_esign 3.4.0 → 3.5.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (50) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +73 -0
  3. data/docusign_esign-2.6.0.rc1.gem +0 -0
  4. data/lib/docusign_esign.rb +24 -0
  5. data/lib/docusign_esign/.DS_Store +0 -0
  6. data/lib/docusign_esign/api/.DS_Store +0 -0
  7. data/lib/docusign_esign/api/accounts_api.rb +362 -0
  8. data/lib/docusign_esign/api/bulk_envelopes_api.rb +126 -4
  9. data/lib/docusign_esign/api/envelopes_api.rb +320 -0
  10. data/lib/docusign_esign/client/.DS_Store +0 -0
  11. data/lib/docusign_esign/models/account_settings_information.rb +11 -1
  12. data/lib/docusign_esign/models/bulk_send_batch_status.rb +287 -0
  13. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +277 -0
  14. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +255 -0
  15. data/lib/docusign_esign/models/bulk_send_error_status.rb +207 -0
  16. data/lib/docusign_esign/models/conditional_recipient_rule.rb +216 -0
  17. data/lib/docusign_esign/models/conditional_recipient_rule_condition.rb +207 -0
  18. data/lib/docusign_esign/models/conditional_recipient_rule_filter.rb +235 -0
  19. data/lib/docusign_esign/models/e_note_configuration.rb +11 -1
  20. data/lib/docusign_esign/models/envelope.rb +13 -4
  21. data/lib/docusign_esign/models/envelope_definition.rb +13 -4
  22. data/lib/docusign_esign/models/envelope_template.rb +13 -4
  23. data/lib/docusign_esign/models/new_user.rb +11 -1
  24. data/lib/docusign_esign/models/proof_service_resource_token.rb +14 -4
  25. data/lib/docusign_esign/models/recipient_additional_notification.rb +14 -4
  26. data/lib/docusign_esign/models/recipient_group.rb +207 -0
  27. data/lib/docusign_esign/models/recipient_option.rb +225 -0
  28. data/lib/docusign_esign/models/recipient_routing.rb +184 -0
  29. data/lib/docusign_esign/models/recipient_rules.rb +187 -0
  30. data/lib/docusign_esign/models/report_in_product_csv_run_request.rb +437 -0
  31. data/lib/docusign_esign/models/report_in_product_field.rb +215 -0
  32. data/lib/docusign_esign/models/report_in_product_get.rb +466 -0
  33. data/lib/docusign_esign/models/report_in_product_list.rb +187 -0
  34. data/lib/docusign_esign/models/report_in_product_list_item.rb +315 -0
  35. data/lib/docusign_esign/models/report_in_product_run_request.rb +397 -0
  36. data/lib/docusign_esign/models/report_in_product_run_response.rb +247 -0
  37. data/lib/docusign_esign/models/report_in_product_run_response_row.rb +194 -0
  38. data/lib/docusign_esign/models/report_in_product_run_response_row_fields.rb +1395 -0
  39. data/lib/docusign_esign/models/report_in_product_save_response.rb +185 -0
  40. data/lib/docusign_esign/models/report_in_product_sent_by_details.rb +199 -0
  41. data/lib/docusign_esign/models/sender_email_notifications.rb +11 -1
  42. data/lib/docusign_esign/models/tab_metadata.rb +21 -1
  43. data/lib/docusign_esign/models/workflow.rb +207 -0
  44. data/lib/docusign_esign/models/workflow_step.rb +254 -0
  45. data/lib/docusign_esign/version.rb +1 -1
  46. data/tests/Gemfile.lock +3 -3
  47. metadata +33 -7
  48. data/docusign_esign-2.4.0.gem +0 -0
  49. data/docusign_esign-2.5.0.rc1.gem +0 -0
  50. data/docusign_esign-3.4.0.rc1.gem +0 -0
@@ -0,0 +1,207 @@
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
+ Swagger Codegen version: 2.4.13-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module DocuSign_eSign
16
+ class Workflow
17
+ #
18
+ attr_accessor :current_workflow_step_id
19
+
20
+ #
21
+ attr_accessor :workflow_status
22
+
23
+ #
24
+ attr_accessor :workflow_steps
25
+
26
+ # Attribute mapping from ruby-style variable name to JSON key.
27
+ def self.attribute_map
28
+ {
29
+ :'current_workflow_step_id' => :'currentWorkflowStepId',
30
+ :'workflow_status' => :'workflowStatus',
31
+ :'workflow_steps' => :'workflowSteps'
32
+ }
33
+ end
34
+
35
+ # Attribute type mapping.
36
+ def self.swagger_types
37
+ {
38
+ :'current_workflow_step_id' => :'String',
39
+ :'workflow_status' => :'String',
40
+ :'workflow_steps' => :'Array<WorkflowStep>'
41
+ }
42
+ end
43
+
44
+ # Initializes the object
45
+ # @param [Hash] attributes Model attributes in the form of hash
46
+ def initialize(attributes = {})
47
+ return unless attributes.is_a?(Hash)
48
+
49
+ # convert string to symbol for hash key
50
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
51
+
52
+ if attributes.has_key?(:'currentWorkflowStepId')
53
+ self.current_workflow_step_id = attributes[:'currentWorkflowStepId']
54
+ end
55
+
56
+ if attributes.has_key?(:'workflowStatus')
57
+ self.workflow_status = attributes[:'workflowStatus']
58
+ end
59
+
60
+ if attributes.has_key?(:'workflowSteps')
61
+ if (value = attributes[:'workflowSteps']).is_a?(Array)
62
+ self.workflow_steps = value
63
+ end
64
+ end
65
+ end
66
+
67
+ # Show invalid properties with the reasons. Usually used together with valid?
68
+ # @return Array for valid properties with the reasons
69
+ def list_invalid_properties
70
+ invalid_properties = Array.new
71
+ invalid_properties
72
+ end
73
+
74
+ # Check to see if the all the properties in the model are valid
75
+ # @return true if the model is valid
76
+ def valid?
77
+ true
78
+ end
79
+
80
+ # Checks equality by comparing each attribute.
81
+ # @param [Object] Object to be compared
82
+ def ==(o)
83
+ return true if self.equal?(o)
84
+ self.class == o.class &&
85
+ current_workflow_step_id == o.current_workflow_step_id &&
86
+ workflow_status == o.workflow_status &&
87
+ workflow_steps == o.workflow_steps
88
+ end
89
+
90
+ # @see the `==` method
91
+ # @param [Object] Object to be compared
92
+ def eql?(o)
93
+ self == o
94
+ end
95
+
96
+ # Calculates hash code according to all attributes.
97
+ # @return [Fixnum] Hash code
98
+ def hash
99
+ [current_workflow_step_id, workflow_status, workflow_steps].hash
100
+ end
101
+
102
+ # Builds the object from hash
103
+ # @param [Hash] attributes Model attributes in the form of hash
104
+ # @return [Object] Returns the model itself
105
+ def build_from_hash(attributes)
106
+ return nil unless attributes.is_a?(Hash)
107
+ self.class.swagger_types.each_pair do |key, type|
108
+ if type =~ /\AArray<(.*)>/i
109
+ # check to ensure the input is an array given that the attribute
110
+ # is documented as an array but the input is not
111
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
112
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
113
+ end
114
+ elsif !attributes[self.class.attribute_map[key]].nil?
115
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
116
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
117
+ end
118
+
119
+ self
120
+ end
121
+
122
+ # Deserializes the data based on type
123
+ # @param string type Data type
124
+ # @param string value Value to be deserialized
125
+ # @return [Object] Deserialized data
126
+ def _deserialize(type, value)
127
+ case type.to_sym
128
+ when :DateTime
129
+ DateTime.parse(value)
130
+ when :Date
131
+ Date.parse(value)
132
+ when :String
133
+ value.to_s
134
+ when :Integer
135
+ value.to_i
136
+ when :Float
137
+ value.to_f
138
+ when :BOOLEAN
139
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
140
+ true
141
+ else
142
+ false
143
+ end
144
+ when :Object
145
+ # generic object (usually a Hash), return directly
146
+ value
147
+ when /\AArray<(?<inner_type>.+)>\z/
148
+ inner_type = Regexp.last_match[:inner_type]
149
+ value.map { |v| _deserialize(inner_type, v) }
150
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
151
+ k_type = Regexp.last_match[:k_type]
152
+ v_type = Regexp.last_match[:v_type]
153
+ {}.tap do |hash|
154
+ value.each do |k, v|
155
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
156
+ end
157
+ end
158
+ else # model
159
+ temp_model = DocuSign_eSign.const_get(type).new
160
+ temp_model.build_from_hash(value)
161
+ end
162
+ end
163
+
164
+ # Returns the string representation of the object
165
+ # @return [String] String presentation of the object
166
+ def to_s
167
+ to_hash.to_s
168
+ end
169
+
170
+ # to_body is an alias to to_hash (backward compatibility)
171
+ # @return [Hash] Returns the object in the form of hash
172
+ def to_body
173
+ to_hash
174
+ end
175
+
176
+ # Returns the object in the form of hash
177
+ # @return [Hash] Returns the object in the form of hash
178
+ def to_hash
179
+ hash = {}
180
+ self.class.attribute_map.each_pair do |attr, param|
181
+ value = self.send(attr)
182
+ next if value.nil?
183
+ hash[param] = _to_hash(value)
184
+ end
185
+ hash
186
+ end
187
+
188
+ # Outputs non-array value in the form of hash
189
+ # For object, use to_hash. Otherwise, just return the value
190
+ # @param [Object] value Any valid value
191
+ # @return [Hash] Returns the value in the form of hash
192
+ def _to_hash(value)
193
+ if value.is_a?(Array)
194
+ value.compact.map { |v| _to_hash(v) }
195
+ elsif value.is_a?(Hash)
196
+ {}.tap do |hash|
197
+ value.each { |k, v| hash[k] = _to_hash(v) }
198
+ end
199
+ elsif value.respond_to? :to_hash
200
+ value.to_hash
201
+ else
202
+ value
203
+ end
204
+ end
205
+
206
+ end
207
+ end
@@ -0,0 +1,254 @@
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
+ Swagger Codegen version: 2.4.13-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module DocuSign_eSign
16
+ class WorkflowStep
17
+ #
18
+ attr_accessor :action
19
+
20
+ #
21
+ attr_accessor :completed_date
22
+
23
+ #
24
+ attr_accessor :item_id
25
+
26
+ attr_accessor :recipient_routing
27
+
28
+ # Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
29
+ attr_accessor :status
30
+
31
+ #
32
+ attr_accessor :triggered_date
33
+
34
+ #
35
+ attr_accessor :trigger_on_item
36
+
37
+ #
38
+ attr_accessor :workflow_step_id
39
+
40
+ # Attribute mapping from ruby-style variable name to JSON key.
41
+ def self.attribute_map
42
+ {
43
+ :'action' => :'action',
44
+ :'completed_date' => :'completedDate',
45
+ :'item_id' => :'itemId',
46
+ :'recipient_routing' => :'recipientRouting',
47
+ :'status' => :'status',
48
+ :'triggered_date' => :'triggeredDate',
49
+ :'trigger_on_item' => :'triggerOnItem',
50
+ :'workflow_step_id' => :'workflowStepId'
51
+ }
52
+ end
53
+
54
+ # Attribute type mapping.
55
+ def self.swagger_types
56
+ {
57
+ :'action' => :'String',
58
+ :'completed_date' => :'String',
59
+ :'item_id' => :'String',
60
+ :'recipient_routing' => :'RecipientRouting',
61
+ :'status' => :'String',
62
+ :'triggered_date' => :'String',
63
+ :'trigger_on_item' => :'String',
64
+ :'workflow_step_id' => :'String'
65
+ }
66
+ end
67
+
68
+ # Initializes the object
69
+ # @param [Hash] attributes Model attributes in the form of hash
70
+ def initialize(attributes = {})
71
+ return unless attributes.is_a?(Hash)
72
+
73
+ # convert string to symbol for hash key
74
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
75
+
76
+ if attributes.has_key?(:'action')
77
+ self.action = attributes[:'action']
78
+ end
79
+
80
+ if attributes.has_key?(:'completedDate')
81
+ self.completed_date = attributes[:'completedDate']
82
+ end
83
+
84
+ if attributes.has_key?(:'itemId')
85
+ self.item_id = attributes[:'itemId']
86
+ end
87
+
88
+ if attributes.has_key?(:'recipientRouting')
89
+ self.recipient_routing = attributes[:'recipientRouting']
90
+ end
91
+
92
+ if attributes.has_key?(:'status')
93
+ self.status = attributes[:'status']
94
+ end
95
+
96
+ if attributes.has_key?(:'triggeredDate')
97
+ self.triggered_date = attributes[:'triggeredDate']
98
+ end
99
+
100
+ if attributes.has_key?(:'triggerOnItem')
101
+ self.trigger_on_item = attributes[:'triggerOnItem']
102
+ end
103
+
104
+ if attributes.has_key?(:'workflowStepId')
105
+ self.workflow_step_id = attributes[:'workflowStepId']
106
+ end
107
+ end
108
+
109
+ # Show invalid properties with the reasons. Usually used together with valid?
110
+ # @return Array for valid properties with the reasons
111
+ def list_invalid_properties
112
+ invalid_properties = Array.new
113
+ invalid_properties
114
+ end
115
+
116
+ # Check to see if the all the properties in the model are valid
117
+ # @return true if the model is valid
118
+ def valid?
119
+ true
120
+ end
121
+
122
+ # Checks equality by comparing each attribute.
123
+ # @param [Object] Object to be compared
124
+ def ==(o)
125
+ return true if self.equal?(o)
126
+ self.class == o.class &&
127
+ action == o.action &&
128
+ completed_date == o.completed_date &&
129
+ item_id == o.item_id &&
130
+ recipient_routing == o.recipient_routing &&
131
+ status == o.status &&
132
+ triggered_date == o.triggered_date &&
133
+ trigger_on_item == o.trigger_on_item &&
134
+ workflow_step_id == o.workflow_step_id
135
+ end
136
+
137
+ # @see the `==` method
138
+ # @param [Object] Object to be compared
139
+ def eql?(o)
140
+ self == o
141
+ end
142
+
143
+ # Calculates hash code according to all attributes.
144
+ # @return [Fixnum] Hash code
145
+ def hash
146
+ [action, completed_date, item_id, recipient_routing, status, triggered_date, trigger_on_item, workflow_step_id].hash
147
+ end
148
+
149
+ # Builds the object from hash
150
+ # @param [Hash] attributes Model attributes in the form of hash
151
+ # @return [Object] Returns the model itself
152
+ def build_from_hash(attributes)
153
+ return nil unless attributes.is_a?(Hash)
154
+ self.class.swagger_types.each_pair do |key, type|
155
+ if type =~ /\AArray<(.*)>/i
156
+ # check to ensure the input is an array given that the attribute
157
+ # is documented as an array but the input is not
158
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
159
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
160
+ end
161
+ elsif !attributes[self.class.attribute_map[key]].nil?
162
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
163
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
164
+ end
165
+
166
+ self
167
+ end
168
+
169
+ # Deserializes the data based on type
170
+ # @param string type Data type
171
+ # @param string value Value to be deserialized
172
+ # @return [Object] Deserialized data
173
+ def _deserialize(type, value)
174
+ case type.to_sym
175
+ when :DateTime
176
+ DateTime.parse(value)
177
+ when :Date
178
+ Date.parse(value)
179
+ when :String
180
+ value.to_s
181
+ when :Integer
182
+ value.to_i
183
+ when :Float
184
+ value.to_f
185
+ when :BOOLEAN
186
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
187
+ true
188
+ else
189
+ false
190
+ end
191
+ when :Object
192
+ # generic object (usually a Hash), return directly
193
+ value
194
+ when /\AArray<(?<inner_type>.+)>\z/
195
+ inner_type = Regexp.last_match[:inner_type]
196
+ value.map { |v| _deserialize(inner_type, v) }
197
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
198
+ k_type = Regexp.last_match[:k_type]
199
+ v_type = Regexp.last_match[:v_type]
200
+ {}.tap do |hash|
201
+ value.each do |k, v|
202
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
203
+ end
204
+ end
205
+ else # model
206
+ temp_model = DocuSign_eSign.const_get(type).new
207
+ temp_model.build_from_hash(value)
208
+ end
209
+ end
210
+
211
+ # Returns the string representation of the object
212
+ # @return [String] String presentation of the object
213
+ def to_s
214
+ to_hash.to_s
215
+ end
216
+
217
+ # to_body is an alias to to_hash (backward compatibility)
218
+ # @return [Hash] Returns the object in the form of hash
219
+ def to_body
220
+ to_hash
221
+ end
222
+
223
+ # Returns the object in the form of hash
224
+ # @return [Hash] Returns the object in the form of hash
225
+ def to_hash
226
+ hash = {}
227
+ self.class.attribute_map.each_pair do |attr, param|
228
+ value = self.send(attr)
229
+ next if value.nil?
230
+ hash[param] = _to_hash(value)
231
+ end
232
+ hash
233
+ end
234
+
235
+ # Outputs non-array value in the form of hash
236
+ # For object, use to_hash. Otherwise, just return the value
237
+ # @param [Object] value Any valid value
238
+ # @return [Hash] Returns the value in the form of hash
239
+ def _to_hash(value)
240
+ if value.is_a?(Array)
241
+ value.compact.map { |v| _to_hash(v) }
242
+ elsif value.is_a?(Hash)
243
+ {}.tap do |hash|
244
+ value.each { |k, v| hash[k] = _to_hash(v) }
245
+ end
246
+ elsif value.respond_to? :to_hash
247
+ value.to_hash
248
+ else
249
+ value
250
+ end
251
+ end
252
+
253
+ end
254
+ end