Class: DocuSign_eSign::FolderItemV2
- Inherits:
-
Object
- Object
- DocuSign_eSign::FolderItemV2
- Defined in:
- lib/docusign_esign/models/folder_item_v2.rb
Overview
Information about folder item results.
Instance Attribute Summary collapse
-
#completed_date_time ⇒ Object
Specifies the date and time this item was completed.
-
#created_date_time ⇒ Object
Indicates the date and time the item was created.
-
#envelope_id ⇒ Object
The envelope ID of the envelope status that failed to post.
-
#envelope_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
-
#expire_date_time ⇒ Object
The date and time the envelope is set to expire.
-
#folder_id ⇒ Object
Returns the value of attribute folder_id.
-
#folder_uri ⇒ Object
Returns the value of attribute folder_uri.
-
#is21_cfr_part11 ⇒ Object
When set to true, indicates that this module is enabled on the account.
-
#last_modified_date_time ⇒ Object
The date and time the item was last modified.
-
#owner_name ⇒ Object
Returns the value of attribute owner_name.
-
#recipients ⇒ Object
An array of powerform recipients.
-
#recipients_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the recipients.
-
#sender_company ⇒ Object
Returns the value of attribute sender_company.
-
#sender_email ⇒ Object
Returns the value of attribute sender_email.
-
#sender_name ⇒ Object
Returns the value of attribute sender_name.
-
#sender_user_id ⇒ Object
Returns the value of attribute sender_user_id.
-
#sent_date_time ⇒ Object
The date and time the envelope was sent.
-
#status ⇒ Object
Indicates the envelope status.
-
#subject ⇒ Object
Returns the value of attribute subject.
-
#template_id ⇒ Object
The unique identifier of the template.
-
#template_uri ⇒ Object
Returns the value of attribute template_uri.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ FolderItemV2
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ FolderItemV2
Initializes the object
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 136 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'completedDateTime') self.completed_date_time = attributes[:'completedDateTime'] end if attributes.has_key?(:'createdDateTime') self.created_date_time = attributes[:'createdDateTime'] end if attributes.has_key?(:'envelopeId') self.envelope_id = attributes[:'envelopeId'] end if attributes.has_key?(:'envelopeUri') self.envelope_uri = attributes[:'envelopeUri'] end if attributes.has_key?(:'expireDateTime') self.expire_date_time = attributes[:'expireDateTime'] end if attributes.has_key?(:'folderId') self.folder_id = attributes[:'folderId'] end if attributes.has_key?(:'folderUri') self.folder_uri = attributes[:'folderUri'] end if attributes.has_key?(:'is21CFRPart11') self.is21_cfr_part11 = attributes[:'is21CFRPart11'] end if attributes.has_key?(:'lastModifiedDateTime') self.last_modified_date_time = attributes[:'lastModifiedDateTime'] end if attributes.has_key?(:'ownerName') self.owner_name = attributes[:'ownerName'] end if attributes.has_key?(:'recipients') self.recipients = attributes[:'recipients'] end if attributes.has_key?(:'recipientsUri') self.recipients_uri = attributes[:'recipientsUri'] end if attributes.has_key?(:'senderCompany') self.sender_company = attributes[:'senderCompany'] end if attributes.has_key?(:'senderEmail') self.sender_email = attributes[:'senderEmail'] end if attributes.has_key?(:'senderName') self.sender_name = attributes[:'senderName'] end if attributes.has_key?(:'senderUserId') self.sender_user_id = attributes[:'senderUserId'] end if attributes.has_key?(:'sentDateTime') self.sent_date_time = attributes[:'sentDateTime'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'subject') self.subject = attributes[:'subject'] end if attributes.has_key?(:'templateId') self.template_id = attributes[:'templateId'] end if attributes.has_key?(:'templateUri') self.template_uri = attributes[:'templateUri'] end end |
Instance Attribute Details
#completed_date_time ⇒ Object
Specifies the date and time this item was completed.
18 19 20 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 18 def completed_date_time @completed_date_time end |
#created_date_time ⇒ Object
Indicates the date and time the item was created.
21 22 23 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 21 def created_date_time @created_date_time end |
#envelope_id ⇒ Object
The envelope ID of the envelope status that failed to post.
24 25 26 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 24 def envelope_id @envelope_id end |
#envelope_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
27 28 29 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 27 def envelope_uri @envelope_uri end |
#expire_date_time ⇒ Object
The date and time the envelope is set to expire.
30 31 32 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 30 def expire_date_time @expire_date_time end |
#folder_id ⇒ Object
Returns the value of attribute folder_id.
33 34 35 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 33 def folder_id @folder_id end |
#folder_uri ⇒ Object
Returns the value of attribute folder_uri.
36 37 38 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 36 def folder_uri @folder_uri end |
#is21_cfr_part11 ⇒ Object
When set to true, indicates that this module is enabled on the account.
39 40 41 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 39 def is21_cfr_part11 @is21_cfr_part11 end |
#last_modified_date_time ⇒ Object
The date and time the item was last modified.
42 43 44 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 42 def last_modified_date_time @last_modified_date_time end |
#owner_name ⇒ Object
Returns the value of attribute owner_name.
45 46 47 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 45 def owner_name @owner_name end |
#recipients ⇒ Object
An array of powerform recipients.
48 49 50 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 48 def recipients @recipients end |
#recipients_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the recipients.
51 52 53 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 51 def recipients_uri @recipients_uri end |
#sender_company ⇒ Object
Returns the value of attribute sender_company.
54 55 56 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 54 def sender_company @sender_company end |
#sender_email ⇒ Object
Returns the value of attribute sender_email.
57 58 59 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 57 def sender_email @sender_email end |
#sender_name ⇒ Object
Returns the value of attribute sender_name.
60 61 62 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 60 def sender_name @sender_name end |
#sender_user_id ⇒ Object
Returns the value of attribute sender_user_id.
63 64 65 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 63 def sender_user_id @sender_user_id end |
#sent_date_time ⇒ Object
The date and time the envelope was sent.
66 67 68 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 66 def sent_date_time @sent_date_time end |
#status ⇒ Object
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.
69 70 71 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 69 def status @status end |
#subject ⇒ Object
Returns the value of attribute subject.
72 73 74 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 72 def subject @subject end |
#template_id ⇒ Object
The unique identifier of the template. If this is not provided, DocuSign will generate a value.
75 76 77 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 75 def template_id @template_id end |
#template_uri ⇒ Object
Returns the value of attribute template_uri.
78 79 80 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 78 def template_uri @template_uri end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 81 def self.attribute_map { :'completed_date_time' => :'completedDateTime', :'created_date_time' => :'createdDateTime', :'envelope_id' => :'envelopeId', :'envelope_uri' => :'envelopeUri', :'expire_date_time' => :'expireDateTime', :'folder_id' => :'folderId', :'folder_uri' => :'folderUri', :'is21_cfr_part11' => :'is21CFRPart11', :'last_modified_date_time' => :'lastModifiedDateTime', :'owner_name' => :'ownerName', :'recipients' => :'recipients', :'recipients_uri' => :'recipientsUri', :'sender_company' => :'senderCompany', :'sender_email' => :'senderEmail', :'sender_name' => :'senderName', :'sender_user_id' => :'senderUserId', :'sent_date_time' => :'sentDateTime', :'status' => :'status', :'subject' => :'subject', :'template_id' => :'templateId', :'template_uri' => :'templateUri' } end |
.swagger_types ⇒ Object
Attribute type mapping.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 108 def self.swagger_types { :'completed_date_time' => :'String', :'created_date_time' => :'String', :'envelope_id' => :'String', :'envelope_uri' => :'String', :'expire_date_time' => :'String', :'folder_id' => :'String', :'folder_uri' => :'String', :'is21_cfr_part11' => :'String', :'last_modified_date_time' => :'String', :'owner_name' => :'String', :'recipients' => :'Recipients', :'recipients_uri' => :'String', :'sender_company' => :'String', :'sender_email' => :'String', :'sender_name' => :'String', :'sender_user_id' => :'String', :'sent_date_time' => :'String', :'status' => :'String', :'subject' => :'String', :'template_id' => :'String', :'template_uri' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 242 def ==(o) return true if self.equal?(o) self.class == o.class && completed_date_time == o.completed_date_time && created_date_time == o.created_date_time && envelope_id == o.envelope_id && envelope_uri == o.envelope_uri && expire_date_time == o.expire_date_time && folder_id == o.folder_id && folder_uri == o.folder_uri && is21_cfr_part11 == o.is21_cfr_part11 && last_modified_date_time == o.last_modified_date_time && owner_name == o.owner_name && recipients == o.recipients && recipients_uri == o.recipients_uri && sender_company == o.sender_company && sender_email == o.sender_email && sender_name == o.sender_name && sender_user_id == o.sender_user_id && sent_date_time == o.sent_date_time && status == o.status && subject == o.subject && template_id == o.template_id && template_uri == o.template_uri end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 304 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = DocuSign_eSign.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
370 371 372 373 374 375 376 377 378 379 380 381 382 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 370 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 283 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
270 271 272 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 270 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
276 277 278 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 276 def hash [completed_date_time, created_date_time, envelope_id, envelope_uri, expire_date_time, folder_id, folder_uri, is21_cfr_part11, last_modified_date_time, owner_name, recipients, recipients_uri, sender_company, sender_email, sender_name, sender_user_id, sent_date_time, status, subject, template_id, template_uri].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
229 230 231 232 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 229 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
350 351 352 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 350 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
356 357 358 359 360 361 362 363 364 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 356 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
344 345 346 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 344 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
236 237 238 |
# File 'lib/docusign_esign/models/folder_item_v2.rb', line 236 def valid? true end |