docusign_esign 3.14.0.rc1 → 3.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/lib/docusign_esign/api/billing_api.rb +4 -0
  4. data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
  5. data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
  6. data/lib/docusign_esign/client/api_client.rb +1 -1
  7. data/lib/docusign_esign/models/account_billing_plan.rb +14 -4
  8. data/lib/docusign_esign/models/account_billing_plan_response.rb +14 -4
  9. data/lib/docusign_esign/models/account_settings_information.rb +39 -1
  10. data/lib/docusign_esign/models/billing_plan_information.rb +14 -4
  11. data/lib/docusign_esign/models/bulk_process_request.rb +194 -0
  12. data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
  13. data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
  14. data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
  15. data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
  16. data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
  17. data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
  18. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +21 -1
  19. data/lib/docusign_esign/models/currency.rb +21 -1
  20. data/lib/docusign_esign/models/envelope.rb +10 -1
  21. data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
  22. data/lib/docusign_esign/models/envelope_definition.rb +10 -1
  23. data/lib/docusign_esign/models/envelope_template.rb +10 -1
  24. data/lib/docusign_esign/models/group.rb +11 -1
  25. data/lib/docusign_esign/models/new_account_definition.rb +14 -4
  26. data/lib/docusign_esign/models/tab_metadata.rb +21 -1
  27. data/lib/docusign_esign/models/user_account_management_granular_information.rb +20 -1
  28. data/lib/docusign_esign/version.rb +1 -1
  29. data/lib/docusign_esign.rb +10 -0
  30. metadata +14 -4
@@ -0,0 +1,194 @@
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 BulkSendBatchError
16
+ #
17
+ attr_accessor :error
18
+
19
+ #
20
+ attr_accessor :error_detail
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'error' => :'error',
26
+ :'error_detail' => :'errorDetail'
27
+ }
28
+ end
29
+
30
+ # Attribute type mapping.
31
+ def self.swagger_types
32
+ {
33
+ :'error' => :'String',
34
+ :'error_detail' => :'String'
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?(:'error')
47
+ self.error = attributes[:'error']
48
+ end
49
+
50
+ if attributes.has_key?(:'errorDetail')
51
+ self.error_detail = attributes[:'errorDetail']
52
+ end
53
+ end
54
+
55
+ # Show invalid properties with the reasons. Usually used together with valid?
56
+ # @return Array for valid properties with the reasons
57
+ def list_invalid_properties
58
+ invalid_properties = Array.new
59
+ invalid_properties
60
+ end
61
+
62
+ # Check to see if the all the properties in the model are valid
63
+ # @return true if the model is valid
64
+ def valid?
65
+ true
66
+ end
67
+
68
+ # Checks equality by comparing each attribute.
69
+ # @param [Object] Object to be compared
70
+ def ==(o)
71
+ return true if self.equal?(o)
72
+ self.class == o.class &&
73
+ error == o.error &&
74
+ error_detail == o.error_detail
75
+ end
76
+
77
+ # @see the `==` method
78
+ # @param [Object] Object to be compared
79
+ def eql?(o)
80
+ self == o
81
+ end
82
+
83
+ # Calculates hash code according to all attributes.
84
+ # @return [Fixnum] Hash code
85
+ def hash
86
+ [error, error_detail].hash
87
+ end
88
+
89
+ # Builds the object from hash
90
+ # @param [Hash] attributes Model attributes in the form of hash
91
+ # @return [Object] Returns the model itself
92
+ def build_from_hash(attributes)
93
+ return nil unless attributes.is_a?(Hash)
94
+ self.class.swagger_types.each_pair do |key, type|
95
+ if type =~ /\AArray<(.*)>/i
96
+ # check to ensure the input is an array given that the attribute
97
+ # is documented as an array but the input is not
98
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
99
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
100
+ end
101
+ elsif !attributes[self.class.attribute_map[key]].nil?
102
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
103
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
104
+ end
105
+
106
+ self
107
+ end
108
+
109
+ # Deserializes the data based on type
110
+ # @param string type Data type
111
+ # @param string value Value to be deserialized
112
+ # @return [Object] Deserialized data
113
+ def _deserialize(type, value)
114
+ case type.to_sym
115
+ when :DateTime
116
+ DateTime.parse(value)
117
+ when :Date
118
+ Date.parse(value)
119
+ when :String
120
+ value.to_s
121
+ when :Integer
122
+ value.to_i
123
+ when :Float
124
+ value.to_f
125
+ when :BOOLEAN
126
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
127
+ true
128
+ else
129
+ false
130
+ end
131
+ when :Object
132
+ # generic object (usually a Hash), return directly
133
+ value
134
+ when /\AArray<(?<inner_type>.+)>\z/
135
+ inner_type = Regexp.last_match[:inner_type]
136
+ value.map { |v| _deserialize(inner_type, v) }
137
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
138
+ k_type = Regexp.last_match[:k_type]
139
+ v_type = Regexp.last_match[:v_type]
140
+ {}.tap do |hash|
141
+ value.each do |k, v|
142
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
143
+ end
144
+ end
145
+ else # model
146
+ temp_model = DocuSign_eSign.const_get(type).new
147
+ temp_model.build_from_hash(value)
148
+ end
149
+ end
150
+
151
+ # Returns the string representation of the object
152
+ # @return [String] String presentation of the object
153
+ def to_s
154
+ to_hash.to_s
155
+ end
156
+
157
+ # to_body is an alias to to_hash (backward compatibility)
158
+ # @return [Hash] Returns the object in the form of hash
159
+ def to_body
160
+ to_hash
161
+ end
162
+
163
+ # Returns the object in the form of hash
164
+ # @return [Hash] Returns the object in the form of hash
165
+ def to_hash
166
+ hash = {}
167
+ self.class.attribute_map.each_pair do |attr, param|
168
+ value = self.send(attr)
169
+ next if value.nil?
170
+ hash[param] = _to_hash(value)
171
+ end
172
+ hash
173
+ end
174
+
175
+ # Outputs non-array value in the form of hash
176
+ # For object, use to_hash. Otherwise, just return the value
177
+ # @param [Object] value Any valid value
178
+ # @return [Hash] Returns the value in the form of hash
179
+ def _to_hash(value)
180
+ if value.is_a?(Array)
181
+ value.compact.map { |v| _to_hash(v) }
182
+ elsif value.is_a?(Hash)
183
+ {}.tap do |hash|
184
+ value.each { |k, v| hash[k] = _to_hash(v) }
185
+ end
186
+ elsif value.respond_to? :to_hash
187
+ value.to_hash
188
+ else
189
+ value
190
+ end
191
+ end
192
+
193
+ end
194
+ end
@@ -19,6 +19,12 @@ module DocuSign_eSign
19
19
  #
20
20
  attr_accessor :bulk_batch_summaries
21
21
 
22
+ #
23
+ attr_accessor :bulk_process_queue_limit
24
+
25
+ #
26
+ attr_accessor :bulk_process_total_queued
27
+
22
28
  # The last position in the result set.
23
29
  attr_accessor :end_position
24
30
 
@@ -48,6 +54,8 @@ module DocuSign_eSign
48
54
  {
49
55
  :'batch_size_limit' => :'batchSizeLimit',
50
56
  :'bulk_batch_summaries' => :'bulkBatchSummaries',
57
+ :'bulk_process_queue_limit' => :'bulkProcessQueueLimit',
58
+ :'bulk_process_total_queued' => :'bulkProcessTotalQueued',
51
59
  :'end_position' => :'endPosition',
52
60
  :'next_uri' => :'nextUri',
53
61
  :'previous_uri' => :'previousUri',
@@ -64,6 +72,8 @@ module DocuSign_eSign
64
72
  {
65
73
  :'batch_size_limit' => :'String',
66
74
  :'bulk_batch_summaries' => :'Array<BulkSendBatchSummary>',
75
+ :'bulk_process_queue_limit' => :'String',
76
+ :'bulk_process_total_queued' => :'String',
67
77
  :'end_position' => :'String',
68
78
  :'next_uri' => :'String',
69
79
  :'previous_uri' => :'String',
@@ -93,6 +103,14 @@ module DocuSign_eSign
93
103
  end
94
104
  end
95
105
 
106
+ if attributes.has_key?(:'bulkProcessQueueLimit')
107
+ self.bulk_process_queue_limit = attributes[:'bulkProcessQueueLimit']
108
+ end
109
+
110
+ if attributes.has_key?(:'bulkProcessTotalQueued')
111
+ self.bulk_process_total_queued = attributes[:'bulkProcessTotalQueued']
112
+ end
113
+
96
114
  if attributes.has_key?(:'endPosition')
97
115
  self.end_position = attributes[:'endPosition']
98
116
  end
@@ -146,6 +164,8 @@ module DocuSign_eSign
146
164
  self.class == o.class &&
147
165
  batch_size_limit == o.batch_size_limit &&
148
166
  bulk_batch_summaries == o.bulk_batch_summaries &&
167
+ bulk_process_queue_limit == o.bulk_process_queue_limit &&
168
+ bulk_process_total_queued == o.bulk_process_total_queued &&
149
169
  end_position == o.end_position &&
150
170
  next_uri == o.next_uri &&
151
171
  previous_uri == o.previous_uri &&
@@ -165,7 +185,7 @@ module DocuSign_eSign
165
185
  # Calculates hash code according to all attributes.
166
186
  # @return [Fixnum] Hash code
167
187
  def hash
168
- [batch_size_limit, bulk_batch_summaries, end_position, next_uri, previous_uri, queue_limit, result_set_size, start_position, total_queued, total_set_size].hash
188
+ [batch_size_limit, bulk_batch_summaries, bulk_process_queue_limit, bulk_process_total_queued, end_position, next_uri, previous_uri, queue_limit, result_set_size, start_position, total_queued, total_set_size].hash
169
189
  end
170
190
 
171
191
  # Builds the object from hash
@@ -152,11 +152,17 @@ module DocuSign_eSign
152
152
 
153
153
  attr_accessor :max_length_metadata
154
154
 
155
+ #
156
+ attr_accessor :max_numerical_value
157
+
155
158
  attr_accessor :merge_field
156
159
 
157
160
  #
158
161
  attr_accessor :merge_field_xml
159
162
 
163
+ #
164
+ attr_accessor :min_numerical_value
165
+
160
166
  #
161
167
  attr_accessor :name
162
168
 
@@ -344,8 +350,10 @@ module DocuSign_eSign
344
350
  :'locked_metadata' => :'lockedMetadata',
345
351
  :'max_length' => :'maxLength',
346
352
  :'max_length_metadata' => :'maxLengthMetadata',
353
+ :'max_numerical_value' => :'maxNumericalValue',
347
354
  :'merge_field' => :'mergeField',
348
355
  :'merge_field_xml' => :'mergeFieldXml',
356
+ :'min_numerical_value' => :'minNumericalValue',
349
357
  :'name' => :'name',
350
358
  :'name_metadata' => :'nameMetadata',
351
359
  :'numerical_value' => :'numericalValue',
@@ -459,8 +467,10 @@ module DocuSign_eSign
459
467
  :'locked_metadata' => :'PropertyMetadata',
460
468
  :'max_length' => :'String',
461
469
  :'max_length_metadata' => :'PropertyMetadata',
470
+ :'max_numerical_value' => :'String',
462
471
  :'merge_field' => :'MergeField',
463
472
  :'merge_field_xml' => :'String',
473
+ :'min_numerical_value' => :'String',
464
474
  :'name' => :'String',
465
475
  :'name_metadata' => :'PropertyMetadata',
466
476
  :'numerical_value' => :'String',
@@ -747,6 +757,10 @@ module DocuSign_eSign
747
757
  self.max_length_metadata = attributes[:'maxLengthMetadata']
748
758
  end
749
759
 
760
+ if attributes.has_key?(:'maxNumericalValue')
761
+ self.max_numerical_value = attributes[:'maxNumericalValue']
762
+ end
763
+
750
764
  if attributes.has_key?(:'mergeField')
751
765
  self.merge_field = attributes[:'mergeField']
752
766
  end
@@ -755,6 +769,10 @@ module DocuSign_eSign
755
769
  self.merge_field_xml = attributes[:'mergeFieldXml']
756
770
  end
757
771
 
772
+ if attributes.has_key?(:'minNumericalValue')
773
+ self.min_numerical_value = attributes[:'minNumericalValue']
774
+ end
775
+
758
776
  if attributes.has_key?(:'name')
759
777
  self.name = attributes[:'name']
760
778
  end
@@ -1036,8 +1054,10 @@ module DocuSign_eSign
1036
1054
  locked_metadata == o.locked_metadata &&
1037
1055
  max_length == o.max_length &&
1038
1056
  max_length_metadata == o.max_length_metadata &&
1057
+ max_numerical_value == o.max_numerical_value &&
1039
1058
  merge_field == o.merge_field &&
1040
1059
  merge_field_xml == o.merge_field_xml &&
1060
+ min_numerical_value == o.min_numerical_value &&
1041
1061
  name == o.name &&
1042
1062
  name_metadata == o.name_metadata &&
1043
1063
  numerical_value == o.numerical_value &&
@@ -1100,7 +1120,7 @@ module DocuSign_eSign
1100
1120
  # Calculates hash code according to all attributes.
1101
1121
  # @return [Fixnum] Hash code
1102
1122
  def hash
1103
- [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, numerical_value, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
1123
+ [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, max_numerical_value, merge_field, merge_field_xml, min_numerical_value, name, name_metadata, numerical_value, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
1104
1124
  end
1105
1125
 
1106
1126
  # Builds the object from hash
@@ -107,6 +107,8 @@ module DocuSign_eSign
107
107
  #
108
108
  attr_accessor :envelope_attachments
109
109
 
110
+ attr_accessor :envelope_custom_metadata
111
+
110
112
  #
111
113
  attr_accessor :envelope_documents
112
114
 
@@ -270,6 +272,7 @@ module DocuSign_eSign
270
272
  :'enable_wet_sign' => :'enableWetSign',
271
273
  :'enforce_signer_visibility' => :'enforceSignerVisibility',
272
274
  :'envelope_attachments' => :'envelopeAttachments',
275
+ :'envelope_custom_metadata' => :'envelopeCustomMetadata',
273
276
  :'envelope_documents' => :'envelopeDocuments',
274
277
  :'envelope_id' => :'envelopeId',
275
278
  :'envelope_id_stamping' => :'envelopeIdStamping',
@@ -353,6 +356,7 @@ module DocuSign_eSign
353
356
  :'enable_wet_sign' => :'String',
354
357
  :'enforce_signer_visibility' => :'String',
355
358
  :'envelope_attachments' => :'Array<Attachment>',
359
+ :'envelope_custom_metadata' => :'EnvelopeCustomMetadata',
356
360
  :'envelope_documents' => :'Array<EnvelopeDocument>',
357
361
  :'envelope_id' => :'String',
358
362
  :'envelope_id_stamping' => :'String',
@@ -539,6 +543,10 @@ module DocuSign_eSign
539
543
  end
540
544
  end
541
545
 
546
+ if attributes.has_key?(:'envelopeCustomMetadata')
547
+ self.envelope_custom_metadata = attributes[:'envelopeCustomMetadata']
548
+ end
549
+
542
550
  if attributes.has_key?(:'envelopeDocuments')
543
551
  if (value = attributes[:'envelopeDocuments']).is_a?(Array)
544
552
  self.envelope_documents = value
@@ -774,6 +782,7 @@ module DocuSign_eSign
774
782
  enable_wet_sign == o.enable_wet_sign &&
775
783
  enforce_signer_visibility == o.enforce_signer_visibility &&
776
784
  envelope_attachments == o.envelope_attachments &&
785
+ envelope_custom_metadata == o.envelope_custom_metadata &&
777
786
  envelope_documents == o.envelope_documents &&
778
787
  envelope_id == o.envelope_id &&
779
788
  envelope_id_stamping == o.envelope_id_stamping &&
@@ -830,7 +839,7 @@ module DocuSign_eSign
830
839
  # Calculates hash code according to all attributes.
831
840
  # @return [Fixnum] Hash code
832
841
  def hash
833
- [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_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
842
+ [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
834
843
  end
835
844
 
836
845
  # Builds the object from hash
@@ -0,0 +1,186 @@
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 EnvelopeCustomMetadata
16
+ #
17
+ attr_accessor :envelope_custom_metadata_details
18
+
19
+ # Attribute mapping from ruby-style variable name to JSON key.
20
+ def self.attribute_map
21
+ {
22
+ :'envelope_custom_metadata_details' => :'envelopeCustomMetadataDetails'
23
+ }
24
+ end
25
+
26
+ # Attribute type mapping.
27
+ def self.swagger_types
28
+ {
29
+ :'envelope_custom_metadata_details' => :'Array<NameValue>'
30
+ }
31
+ end
32
+
33
+ # Initializes the object
34
+ # @param [Hash] attributes Model attributes in the form of hash
35
+ def initialize(attributes = {})
36
+ return unless attributes.is_a?(Hash)
37
+
38
+ # convert string to symbol for hash key
39
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
40
+
41
+ if attributes.has_key?(:'envelopeCustomMetadataDetails')
42
+ if (value = attributes[:'envelopeCustomMetadataDetails']).is_a?(Array)
43
+ self.envelope_custom_metadata_details = value
44
+ end
45
+ end
46
+ end
47
+
48
+ # Show invalid properties with the reasons. Usually used together with valid?
49
+ # @return Array for valid properties with the reasons
50
+ def list_invalid_properties
51
+ invalid_properties = Array.new
52
+ invalid_properties
53
+ end
54
+
55
+ # Check to see if the all the properties in the model are valid
56
+ # @return true if the model is valid
57
+ def valid?
58
+ true
59
+ end
60
+
61
+ # Checks equality by comparing each attribute.
62
+ # @param [Object] Object to be compared
63
+ def ==(o)
64
+ return true if self.equal?(o)
65
+ self.class == o.class &&
66
+ envelope_custom_metadata_details == o.envelope_custom_metadata_details
67
+ end
68
+
69
+ # @see the `==` method
70
+ # @param [Object] Object to be compared
71
+ def eql?(o)
72
+ self == o
73
+ end
74
+
75
+ # Calculates hash code according to all attributes.
76
+ # @return [Fixnum] Hash code
77
+ def hash
78
+ [envelope_custom_metadata_details].hash
79
+ end
80
+
81
+ # Builds the object from hash
82
+ # @param [Hash] attributes Model attributes in the form of hash
83
+ # @return [Object] Returns the model itself
84
+ def build_from_hash(attributes)
85
+ return nil unless attributes.is_a?(Hash)
86
+ self.class.swagger_types.each_pair do |key, type|
87
+ if type =~ /\AArray<(.*)>/i
88
+ # check to ensure the input is an array given that the attribute
89
+ # is documented as an array but the input is not
90
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
91
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
92
+ end
93
+ elsif !attributes[self.class.attribute_map[key]].nil?
94
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
95
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
96
+ end
97
+
98
+ self
99
+ end
100
+
101
+ # Deserializes the data based on type
102
+ # @param string type Data type
103
+ # @param string value Value to be deserialized
104
+ # @return [Object] Deserialized data
105
+ def _deserialize(type, value)
106
+ case type.to_sym
107
+ when :DateTime
108
+ DateTime.parse(value)
109
+ when :Date
110
+ Date.parse(value)
111
+ when :String
112
+ value.to_s
113
+ when :Integer
114
+ value.to_i
115
+ when :Float
116
+ value.to_f
117
+ when :BOOLEAN
118
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
119
+ true
120
+ else
121
+ false
122
+ end
123
+ when :Object
124
+ # generic object (usually a Hash), return directly
125
+ value
126
+ when /\AArray<(?<inner_type>.+)>\z/
127
+ inner_type = Regexp.last_match[:inner_type]
128
+ value.map { |v| _deserialize(inner_type, v) }
129
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
130
+ k_type = Regexp.last_match[:k_type]
131
+ v_type = Regexp.last_match[:v_type]
132
+ {}.tap do |hash|
133
+ value.each do |k, v|
134
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
135
+ end
136
+ end
137
+ else # model
138
+ temp_model = DocuSign_eSign.const_get(type).new
139
+ temp_model.build_from_hash(value)
140
+ end
141
+ end
142
+
143
+ # Returns the string representation of the object
144
+ # @return [String] String presentation of the object
145
+ def to_s
146
+ to_hash.to_s
147
+ end
148
+
149
+ # to_body is an alias to to_hash (backward compatibility)
150
+ # @return [Hash] Returns the object in the form of hash
151
+ def to_body
152
+ to_hash
153
+ end
154
+
155
+ # Returns the object in the form of hash
156
+ # @return [Hash] Returns the object in the form of hash
157
+ def to_hash
158
+ hash = {}
159
+ self.class.attribute_map.each_pair do |attr, param|
160
+ value = self.send(attr)
161
+ next if value.nil?
162
+ hash[param] = _to_hash(value)
163
+ end
164
+ hash
165
+ end
166
+
167
+ # Outputs non-array value in the form of hash
168
+ # For object, use to_hash. Otherwise, just return the value
169
+ # @param [Object] value Any valid value
170
+ # @return [Hash] Returns the value in the form of hash
171
+ def _to_hash(value)
172
+ if value.is_a?(Array)
173
+ value.compact.map { |v| _to_hash(v) }
174
+ elsif value.is_a?(Hash)
175
+ {}.tap do |hash|
176
+ value.each { |k, v| hash[k] = _to_hash(v) }
177
+ end
178
+ elsif value.respond_to? :to_hash
179
+ value.to_hash
180
+ else
181
+ value
182
+ end
183
+ end
184
+
185
+ end
186
+ end
@@ -122,6 +122,8 @@ module DocuSign_eSign
122
122
  #
123
123
  attr_accessor :envelope_attachments
124
124
 
125
+ attr_accessor :envelope_custom_metadata
126
+
125
127
  #
126
128
  attr_accessor :envelope_documents
127
129
 
@@ -306,6 +308,7 @@ module DocuSign_eSign
306
308
  :'enable_wet_sign' => :'enableWetSign',
307
309
  :'enforce_signer_visibility' => :'enforceSignerVisibility',
308
310
  :'envelope_attachments' => :'envelopeAttachments',
311
+ :'envelope_custom_metadata' => :'envelopeCustomMetadata',
309
312
  :'envelope_documents' => :'envelopeDocuments',
310
313
  :'envelope_id' => :'envelopeId',
311
314
  :'envelope_id_stamping' => :'envelopeIdStamping',
@@ -400,6 +403,7 @@ module DocuSign_eSign
400
403
  :'enable_wet_sign' => :'String',
401
404
  :'enforce_signer_visibility' => :'String',
402
405
  :'envelope_attachments' => :'Array<Attachment>',
406
+ :'envelope_custom_metadata' => :'EnvelopeCustomMetadata',
403
407
  :'envelope_documents' => :'Array<EnvelopeDocument>',
404
408
  :'envelope_id' => :'String',
405
409
  :'envelope_id_stamping' => :'String',
@@ -618,6 +622,10 @@ module DocuSign_eSign
618
622
  end
619
623
  end
620
624
 
625
+ if attributes.has_key?(:'envelopeCustomMetadata')
626
+ self.envelope_custom_metadata = attributes[:'envelopeCustomMetadata']
627
+ end
628
+
621
629
  if attributes.has_key?(:'envelopeDocuments')
622
630
  if (value = attributes[:'envelopeDocuments']).is_a?(Array)
623
631
  self.envelope_documents = value
@@ -886,6 +894,7 @@ module DocuSign_eSign
886
894
  enable_wet_sign == o.enable_wet_sign &&
887
895
  enforce_signer_visibility == o.enforce_signer_visibility &&
888
896
  envelope_attachments == o.envelope_attachments &&
897
+ envelope_custom_metadata == o.envelope_custom_metadata &&
889
898
  envelope_documents == o.envelope_documents &&
890
899
  envelope_id == o.envelope_id &&
891
900
  envelope_id_stamping == o.envelope_id_stamping &&
@@ -948,7 +957,7 @@ module DocuSign_eSign
948
957
  # Calculates hash code according to all attributes.
949
958
  # @return [Fixnum] Hash code
950
959
  def hash
951
- [access_control_list_base64, accessibility, allow_comments, allow_markup, allow_reassign, allow_recipient_recursion, allow_view_history, any_signer, asynchronous, attachments, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, composite_templates, 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, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, event_notification, event_notifications, 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, password, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, recipient_view_request, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, template_roles, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
960
+ [access_control_list_base64, accessibility, allow_comments, allow_markup, allow_reassign, allow_recipient_recursion, allow_view_history, any_signer, asynchronous, attachments, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, composite_templates, 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, 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, event_notification, event_notifications, 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, password, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, recipient_view_request, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, template_roles, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
952
961
  end
953
962
 
954
963
  # Builds the object from hash