docusign_esign 3.27.0.rc1 → 4.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/lib/docusign_esign/api/envelopes_api.rb +29 -21
  4. data/lib/docusign_esign/api/templates_api.rb +6 -6
  5. data/lib/docusign_esign/client/api_client.rb +1 -1
  6. data/lib/docusign_esign/models/account_settings_information.rb +191 -61
  7. data/lib/docusign_esign/models/account_ui_settings.rb +21 -1
  8. data/lib/docusign_esign/models/envelope.rb +11 -1
  9. data/lib/docusign_esign/models/envelope_definition.rb +11 -1
  10. data/lib/docusign_esign/models/envelope_template.rb +11 -1
  11. data/lib/docusign_esign/models/envelope_view_document_settings.rb +214 -0
  12. data/lib/docusign_esign/models/envelope_view_envelope_custom_field_settings.rb +184 -0
  13. data/lib/docusign_esign/models/envelope_view_recipient_settings.rb +214 -0
  14. data/lib/docusign_esign/models/envelope_view_request.rb +204 -0
  15. data/lib/docusign_esign/models/envelope_view_settings.rb +304 -0
  16. data/lib/docusign_esign/models/envelope_view_tagger_settings.rb +204 -0
  17. data/lib/docusign_esign/models/envelope_view_template_settings.rb +184 -0
  18. data/lib/docusign_esign/models/group.rb +11 -1
  19. data/lib/docusign_esign/models/palette_item_settings.rb +184 -0
  20. data/lib/docusign_esign/models/palette_settings.rb +244 -0
  21. data/lib/docusign_esign/models/recipient_view_request.rb +11 -1
  22. data/lib/docusign_esign/models/template_view_request.rb +194 -0
  23. data/lib/docusign_esign/models/user_settings_information.rb +61 -1
  24. data/lib/docusign_esign/version.rb +1 -1
  25. data/lib/docusign_esign.rb +10 -1
  26. metadata +12 -2
@@ -32,6 +32,9 @@ module DocuSign_eSign
32
32
  # The group type.
33
33
  attr_accessor :group_type
34
34
 
35
+ #
36
+ attr_accessor :last_modified_on
37
+
35
38
  # The ID of the permission profile associated with the group.
36
39
  attr_accessor :permission_profile_id
37
40
 
@@ -50,6 +53,7 @@ module DocuSign_eSign
50
53
  :'group_id' => :'groupId',
51
54
  :'group_name' => :'groupName',
52
55
  :'group_type' => :'groupType',
56
+ :'last_modified_on' => :'lastModifiedOn',
53
57
  :'permission_profile_id' => :'permissionProfileId',
54
58
  :'users' => :'users',
55
59
  :'users_count' => :'usersCount'
@@ -65,6 +69,7 @@ module DocuSign_eSign
65
69
  :'group_id' => :'String',
66
70
  :'group_name' => :'String',
67
71
  :'group_type' => :'String',
72
+ :'last_modified_on' => :'String',
68
73
  :'permission_profile_id' => :'String',
69
74
  :'users' => :'Array<UserInfo>',
70
75
  :'users_count' => :'String'
@@ -103,6 +108,10 @@ module DocuSign_eSign
103
108
  self.group_type = attributes[:'groupType']
104
109
  end
105
110
 
111
+ if attributes.has_key?(:'lastModifiedOn')
112
+ self.last_modified_on = attributes[:'lastModifiedOn']
113
+ end
114
+
106
115
  if attributes.has_key?(:'permissionProfileId')
107
116
  self.permission_profile_id = attributes[:'permissionProfileId']
108
117
  end
@@ -142,6 +151,7 @@ module DocuSign_eSign
142
151
  group_id == o.group_id &&
143
152
  group_name == o.group_name &&
144
153
  group_type == o.group_type &&
154
+ last_modified_on == o.last_modified_on &&
145
155
  permission_profile_id == o.permission_profile_id &&
146
156
  users == o.users &&
147
157
  users_count == o.users_count
@@ -156,7 +166,7 @@ module DocuSign_eSign
156
166
  # Calculates hash code according to all attributes.
157
167
  # @return [Fixnum] Hash code
158
168
  def hash
159
- [access_type, ds_group_id, error_details, group_id, group_name, group_type, permission_profile_id, users, users_count].hash
169
+ [access_type, ds_group_id, error_details, group_id, group_name, group_type, last_modified_on, permission_profile_id, users, users_count].hash
160
170
  end
161
171
 
162
172
  # Builds the object from hash
@@ -0,0 +1,184 @@
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 PaletteItemSettings
16
+ #
17
+ attr_accessor :show
18
+
19
+ # Attribute mapping from ruby-style variable name to JSON key.
20
+ def self.attribute_map
21
+ {
22
+ :'show' => :'show'
23
+ }
24
+ end
25
+
26
+ # Attribute type mapping.
27
+ def self.swagger_types
28
+ {
29
+ :'show' => :'String'
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?(:'show')
42
+ self.show = attributes[:'show']
43
+ end
44
+ end
45
+
46
+ # Show invalid properties with the reasons. Usually used together with valid?
47
+ # @return Array for valid properties with the reasons
48
+ def list_invalid_properties
49
+ invalid_properties = Array.new
50
+ invalid_properties
51
+ end
52
+
53
+ # Check to see if the all the properties in the model are valid
54
+ # @return true if the model is valid
55
+ def valid?
56
+ true
57
+ end
58
+
59
+ # Checks equality by comparing each attribute.
60
+ # @param [Object] Object to be compared
61
+ def ==(o)
62
+ return true if self.equal?(o)
63
+ self.class == o.class &&
64
+ show == o.show
65
+ end
66
+
67
+ # @see the `==` method
68
+ # @param [Object] Object to be compared
69
+ def eql?(o)
70
+ self == o
71
+ end
72
+
73
+ # Calculates hash code according to all attributes.
74
+ # @return [Fixnum] Hash code
75
+ def hash
76
+ [show].hash
77
+ end
78
+
79
+ # Builds the object from hash
80
+ # @param [Hash] attributes Model attributes in the form of hash
81
+ # @return [Object] Returns the model itself
82
+ def build_from_hash(attributes)
83
+ return nil unless attributes.is_a?(Hash)
84
+ self.class.swagger_types.each_pair do |key, type|
85
+ if type =~ /\AArray<(.*)>/i
86
+ # check to ensure the input is an array given that the attribute
87
+ # is documented as an array but the input is not
88
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
89
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
90
+ end
91
+ elsif !attributes[self.class.attribute_map[key]].nil?
92
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
93
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
94
+ end
95
+
96
+ self
97
+ end
98
+
99
+ # Deserializes the data based on type
100
+ # @param string type Data type
101
+ # @param string value Value to be deserialized
102
+ # @return [Object] Deserialized data
103
+ def _deserialize(type, value)
104
+ case type.to_sym
105
+ when :DateTime
106
+ DateTime.parse(value)
107
+ when :Date
108
+ Date.parse(value)
109
+ when :String
110
+ value.to_s
111
+ when :Integer
112
+ value.to_i
113
+ when :Float
114
+ value.to_f
115
+ when :BOOLEAN
116
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
117
+ true
118
+ else
119
+ false
120
+ end
121
+ when :Object
122
+ # generic object (usually a Hash), return directly
123
+ value
124
+ when /\AArray<(?<inner_type>.+)>\z/
125
+ inner_type = Regexp.last_match[:inner_type]
126
+ value.map { |v| _deserialize(inner_type, v) }
127
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
128
+ k_type = Regexp.last_match[:k_type]
129
+ v_type = Regexp.last_match[:v_type]
130
+ {}.tap do |hash|
131
+ value.each do |k, v|
132
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
133
+ end
134
+ end
135
+ else # model
136
+ temp_model = DocuSign_eSign.const_get(type).new
137
+ temp_model.build_from_hash(value)
138
+ end
139
+ end
140
+
141
+ # Returns the string representation of the object
142
+ # @return [String] String presentation of the object
143
+ def to_s
144
+ to_hash.to_s
145
+ end
146
+
147
+ # to_body is an alias to to_hash (backward compatibility)
148
+ # @return [Hash] Returns the object in the form of hash
149
+ def to_body
150
+ to_hash
151
+ end
152
+
153
+ # Returns the object in the form of hash
154
+ # @return [Hash] Returns the object in the form of hash
155
+ def to_hash
156
+ hash = {}
157
+ self.class.attribute_map.each_pair do |attr, param|
158
+ value = self.send(attr)
159
+ next if value.nil?
160
+ hash[param] = _to_hash(value)
161
+ end
162
+ hash
163
+ end
164
+
165
+ # Outputs non-array value in the form of hash
166
+ # For object, use to_hash. Otherwise, just return the value
167
+ # @param [Object] value Any valid value
168
+ # @return [Hash] Returns the value in the form of hash
169
+ def _to_hash(value)
170
+ if value.is_a?(Array)
171
+ value.compact.map { |v| _to_hash(v) }
172
+ elsif value.is_a?(Hash)
173
+ {}.tap do |hash|
174
+ value.each { |k, v| hash[k] = _to_hash(v) }
175
+ end
176
+ elsif value.respond_to? :to_hash
177
+ value.to_hash
178
+ else
179
+ value
180
+ end
181
+ end
182
+
183
+ end
184
+ end
@@ -0,0 +1,244 @@
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 PaletteSettings
16
+ #
17
+ attr_accessor :annotations
18
+
19
+ #
20
+ attr_accessor :custom
21
+
22
+ #
23
+ attr_accessor :merge
24
+
25
+ #
26
+ attr_accessor :notary
27
+
28
+ #
29
+ attr_accessor :seals
30
+
31
+ #
32
+ attr_accessor :smart_contracts
33
+
34
+ #
35
+ attr_accessor :smart_sections
36
+
37
+ # Attribute mapping from ruby-style variable name to JSON key.
38
+ def self.attribute_map
39
+ {
40
+ :'annotations' => :'annotations',
41
+ :'custom' => :'custom',
42
+ :'merge' => :'merge',
43
+ :'notary' => :'notary',
44
+ :'seals' => :'seals',
45
+ :'smart_contracts' => :'smartContracts',
46
+ :'smart_sections' => :'smartSections'
47
+ }
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.swagger_types
52
+ {
53
+ :'annotations' => :'PaletteItemSettings',
54
+ :'custom' => :'PaletteItemSettings',
55
+ :'merge' => :'PaletteItemSettings',
56
+ :'notary' => :'PaletteItemSettings',
57
+ :'seals' => :'PaletteItemSettings',
58
+ :'smart_contracts' => :'PaletteItemSettings',
59
+ :'smart_sections' => :'PaletteItemSettings'
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?(:'annotations')
72
+ self.annotations = attributes[:'annotations']
73
+ end
74
+
75
+ if attributes.has_key?(:'custom')
76
+ self.custom = attributes[:'custom']
77
+ end
78
+
79
+ if attributes.has_key?(:'merge')
80
+ self.merge = attributes[:'merge']
81
+ end
82
+
83
+ if attributes.has_key?(:'notary')
84
+ self.notary = attributes[:'notary']
85
+ end
86
+
87
+ if attributes.has_key?(:'seals')
88
+ self.seals = attributes[:'seals']
89
+ end
90
+
91
+ if attributes.has_key?(:'smartContracts')
92
+ self.smart_contracts = attributes[:'smartContracts']
93
+ end
94
+
95
+ if attributes.has_key?(:'smartSections')
96
+ self.smart_sections = attributes[:'smartSections']
97
+ end
98
+ end
99
+
100
+ # Show invalid properties with the reasons. Usually used together with valid?
101
+ # @return Array for valid properties with the reasons
102
+ def list_invalid_properties
103
+ invalid_properties = Array.new
104
+ invalid_properties
105
+ end
106
+
107
+ # Check to see if the all the properties in the model are valid
108
+ # @return true if the model is valid
109
+ def valid?
110
+ true
111
+ end
112
+
113
+ # Checks equality by comparing each attribute.
114
+ # @param [Object] Object to be compared
115
+ def ==(o)
116
+ return true if self.equal?(o)
117
+ self.class == o.class &&
118
+ annotations == o.annotations &&
119
+ custom == o.custom &&
120
+ merge == o.merge &&
121
+ notary == o.notary &&
122
+ seals == o.seals &&
123
+ smart_contracts == o.smart_contracts &&
124
+ smart_sections == o.smart_sections
125
+ end
126
+
127
+ # @see the `==` method
128
+ # @param [Object] Object to be compared
129
+ def eql?(o)
130
+ self == o
131
+ end
132
+
133
+ # Calculates hash code according to all attributes.
134
+ # @return [Fixnum] Hash code
135
+ def hash
136
+ [annotations, custom, merge, notary, seals, smart_contracts, smart_sections].hash
137
+ end
138
+
139
+ # Builds the object from hash
140
+ # @param [Hash] attributes Model attributes in the form of hash
141
+ # @return [Object] Returns the model itself
142
+ def build_from_hash(attributes)
143
+ return nil unless attributes.is_a?(Hash)
144
+ self.class.swagger_types.each_pair do |key, type|
145
+ if type =~ /\AArray<(.*)>/i
146
+ # check to ensure the input is an array given that the attribute
147
+ # is documented as an array but the input is not
148
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
149
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
150
+ end
151
+ elsif !attributes[self.class.attribute_map[key]].nil?
152
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
153
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
154
+ end
155
+
156
+ self
157
+ end
158
+
159
+ # Deserializes the data based on type
160
+ # @param string type Data type
161
+ # @param string value Value to be deserialized
162
+ # @return [Object] Deserialized data
163
+ def _deserialize(type, value)
164
+ case type.to_sym
165
+ when :DateTime
166
+ DateTime.parse(value)
167
+ when :Date
168
+ Date.parse(value)
169
+ when :String
170
+ value.to_s
171
+ when :Integer
172
+ value.to_i
173
+ when :Float
174
+ value.to_f
175
+ when :BOOLEAN
176
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
177
+ true
178
+ else
179
+ false
180
+ end
181
+ when :Object
182
+ # generic object (usually a Hash), return directly
183
+ value
184
+ when /\AArray<(?<inner_type>.+)>\z/
185
+ inner_type = Regexp.last_match[:inner_type]
186
+ value.map { |v| _deserialize(inner_type, v) }
187
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
188
+ k_type = Regexp.last_match[:k_type]
189
+ v_type = Regexp.last_match[:v_type]
190
+ {}.tap do |hash|
191
+ value.each do |k, v|
192
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
193
+ end
194
+ end
195
+ else # model
196
+ temp_model = DocuSign_eSign.const_get(type).new
197
+ temp_model.build_from_hash(value)
198
+ end
199
+ end
200
+
201
+ # Returns the string representation of the object
202
+ # @return [String] String presentation of the object
203
+ def to_s
204
+ to_hash.to_s
205
+ end
206
+
207
+ # to_body is an alias to to_hash (backward compatibility)
208
+ # @return [Hash] Returns the object in the form of hash
209
+ def to_body
210
+ to_hash
211
+ end
212
+
213
+ # Returns the object in the form of hash
214
+ # @return [Hash] Returns the object in the form of hash
215
+ def to_hash
216
+ hash = {}
217
+ self.class.attribute_map.each_pair do |attr, param|
218
+ value = self.send(attr)
219
+ next if value.nil?
220
+ hash[param] = _to_hash(value)
221
+ end
222
+ hash
223
+ end
224
+
225
+ # Outputs non-array value in the form of hash
226
+ # For object, use to_hash. Otherwise, just return the value
227
+ # @param [Object] value Any valid value
228
+ # @return [Hash] Returns the value in the form of hash
229
+ def _to_hash(value)
230
+ if value.is_a?(Array)
231
+ value.compact.map { |v| _to_hash(v) }
232
+ elsif value.is_a?(Hash)
233
+ {}.tap do |hash|
234
+ value.each { |k, v| hash[k] = _to_hash(v) }
235
+ end
236
+ elsif value.respond_to? :to_hash
237
+ value.to_hash
238
+ else
239
+ value
240
+ end
241
+ end
242
+
243
+ end
244
+ end
@@ -29,6 +29,9 @@ module DocuSign_eSign
29
29
  # A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters.
30
30
  attr_accessor :client_user_id
31
31
 
32
+ #
33
+ attr_accessor :display_format
34
+
32
35
  # Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.
33
36
  attr_accessor :email
34
37
 
@@ -73,6 +76,7 @@ module DocuSign_eSign
73
76
  :'authentication_method' => :'authenticationMethod',
74
77
  :'client_ur_ls' => :'clientURLs',
75
78
  :'client_user_id' => :'clientUserId',
79
+ :'display_format' => :'displayFormat',
76
80
  :'email' => :'email',
77
81
  :'frame_ancestors' => :'frameAncestors',
78
82
  :'message_origins' => :'messageOrigins',
@@ -96,6 +100,7 @@ module DocuSign_eSign
96
100
  :'authentication_method' => :'String',
97
101
  :'client_ur_ls' => :'RecipientTokenClientURLs',
98
102
  :'client_user_id' => :'String',
103
+ :'display_format' => :'String',
99
104
  :'email' => :'String',
100
105
  :'frame_ancestors' => :'Array<String>',
101
106
  :'message_origins' => :'Array<String>',
@@ -139,6 +144,10 @@ module DocuSign_eSign
139
144
  self.client_user_id = attributes[:'clientUserId']
140
145
  end
141
146
 
147
+ if attributes.has_key?(:'displayFormat')
148
+ self.display_format = attributes[:'displayFormat']
149
+ end
150
+
142
151
  if attributes.has_key?(:'email')
143
152
  self.email = attributes[:'email']
144
153
  end
@@ -215,6 +224,7 @@ module DocuSign_eSign
215
224
  authentication_method == o.authentication_method &&
216
225
  client_ur_ls == o.client_ur_ls &&
217
226
  client_user_id == o.client_user_id &&
227
+ display_format == o.display_format &&
218
228
  email == o.email &&
219
229
  frame_ancestors == o.frame_ancestors &&
220
230
  message_origins == o.message_origins &&
@@ -238,7 +248,7 @@ module DocuSign_eSign
238
248
  # Calculates hash code according to all attributes.
239
249
  # @return [Fixnum] Hash code
240
250
  def hash
241
- [assertion_id, authentication_instant, authentication_method, client_ur_ls, client_user_id, email, frame_ancestors, message_origins, ping_frequency, ping_url, recipient_id, return_url, security_domain, user_id, user_name, x_frame_options, x_frame_options_allow_from_url].hash
251
+ [assertion_id, authentication_instant, authentication_method, client_ur_ls, client_user_id, display_format, email, frame_ancestors, message_origins, ping_frequency, ping_url, recipient_id, return_url, security_domain, user_id, user_name, x_frame_options, x_frame_options_allow_from_url].hash
242
252
  end
243
253
 
244
254
  # Builds the object from hash