Class: DocuSign_eSign::BulkSendBatchStatus
- Inherits:
-
Object
- Object
- DocuSign_eSign::BulkSendBatchStatus
- Defined in:
- lib/docusign_esign/models/bulk_send_batch_status.rb
Instance Attribute Summary collapse
-
#batch_id ⇒ Object
Returns the value of attribute batch_id.
-
#batch_name ⇒ Object
Returns the value of attribute batch_name.
-
#batch_size ⇒ Object
Returns the value of attribute batch_size.
-
#bulk_errors ⇒ Object
Returns the value of attribute bulk_errors.
-
#envelope_id_or_template_id ⇒ Object
Returns the value of attribute envelope_id_or_template_id.
-
#envelopes_info ⇒ Object
Returns the value of attribute envelopes_info.
-
#envelopes_uri ⇒ Object
Returns the value of attribute envelopes_uri.
-
#failed ⇒ Object
Returns the value of attribute failed.
-
#mailing_list_id ⇒ Object
Returns the value of attribute mailing_list_id.
-
#mailing_list_name ⇒ Object
Returns the value of attribute mailing_list_name.
-
#owner_user_id ⇒ Object
Returns the value of attribute owner_user_id.
-
#queued ⇒ Object
Returns the value of attribute queued.
-
#sender_user_id ⇒ Object
Returns the value of attribute sender_user_id.
-
#sent ⇒ Object
Returns the value of attribute sent.
-
#submitted_date ⇒ Object
Returns the value of attribute submitted_date.
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 = {}) ⇒ BulkSendBatchStatus
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 = {}) ⇒ BulkSendBatchStatus
Initializes the object
104 105 106 107 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 133 134 135 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 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 104 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?(:'batchId') self.batch_id = attributes[:'batchId'] end if attributes.has_key?(:'batchName') self.batch_name = attributes[:'batchName'] end if attributes.has_key?(:'batchSize') self.batch_size = attributes[:'batchSize'] end if attributes.has_key?(:'bulkErrors') if (value = attributes[:'bulkErrors']).is_a?(Array) self.bulk_errors = value end end if attributes.has_key?(:'envelopeIdOrTemplateId') self.envelope_id_or_template_id = attributes[:'envelopeIdOrTemplateId'] end if attributes.has_key?(:'envelopesInfo') self.envelopes_info = attributes[:'envelopesInfo'] end if attributes.has_key?(:'envelopesUri') self.envelopes_uri = attributes[:'envelopesUri'] end if attributes.has_key?(:'failed') self.failed = attributes[:'failed'] end if attributes.has_key?(:'mailingListId') self.mailing_list_id = attributes[:'mailingListId'] end if attributes.has_key?(:'mailingListName') self.mailing_list_name = attributes[:'mailingListName'] end if attributes.has_key?(:'ownerUserId') self.owner_user_id = attributes[:'ownerUserId'] end if attributes.has_key?(:'queued') self.queued = attributes[:'queued'] end if attributes.has_key?(:'senderUserId') self.sender_user_id = attributes[:'senderUserId'] end if attributes.has_key?(:'sent') self.sent = attributes[:'sent'] end if attributes.has_key?(:'submittedDate') self.submitted_date = attributes[:'submittedDate'] end end |
Instance Attribute Details
#batch_id ⇒ Object
Returns the value of attribute batch_id.
17 18 19 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 17 def batch_id @batch_id end |
#batch_name ⇒ Object
Returns the value of attribute batch_name.
20 21 22 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 20 def batch_name @batch_name end |
#batch_size ⇒ Object
Returns the value of attribute batch_size.
23 24 25 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 23 def batch_size @batch_size end |
#bulk_errors ⇒ Object
Returns the value of attribute bulk_errors.
26 27 28 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 26 def bulk_errors @bulk_errors end |
#envelope_id_or_template_id ⇒ Object
Returns the value of attribute envelope_id_or_template_id.
29 30 31 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 29 def envelope_id_or_template_id @envelope_id_or_template_id end |
#envelopes_info ⇒ Object
Returns the value of attribute envelopes_info.
31 32 33 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 31 def envelopes_info @envelopes_info end |
#envelopes_uri ⇒ Object
Returns the value of attribute envelopes_uri.
34 35 36 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 34 def envelopes_uri @envelopes_uri end |
#failed ⇒ Object
Returns the value of attribute failed.
37 38 39 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 37 def failed @failed end |
#mailing_list_id ⇒ Object
Returns the value of attribute mailing_list_id.
40 41 42 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 40 def mailing_list_id @mailing_list_id end |
#mailing_list_name ⇒ Object
Returns the value of attribute mailing_list_name.
43 44 45 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 43 def mailing_list_name @mailing_list_name end |
#owner_user_id ⇒ Object
Returns the value of attribute owner_user_id.
46 47 48 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 46 def owner_user_id @owner_user_id end |
#queued ⇒ Object
Returns the value of attribute queued.
49 50 51 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 49 def queued @queued end |
#sender_user_id ⇒ Object
Returns the value of attribute sender_user_id.
52 53 54 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 52 def sender_user_id @sender_user_id end |
#sent ⇒ Object
Returns the value of attribute sent.
55 56 57 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 55 def sent @sent end |
#submitted_date ⇒ Object
Returns the value of attribute submitted_date.
58 59 60 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 58 def submitted_date @submitted_date end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 61 def self.attribute_map { :'batch_id' => :'batchId', :'batch_name' => :'batchName', :'batch_size' => :'batchSize', :'bulk_errors' => :'bulkErrors', :'envelope_id_or_template_id' => :'envelopeIdOrTemplateId', :'envelopes_info' => :'envelopesInfo', :'envelopes_uri' => :'envelopesUri', :'failed' => :'failed', :'mailing_list_id' => :'mailingListId', :'mailing_list_name' => :'mailingListName', :'owner_user_id' => :'ownerUserId', :'queued' => :'queued', :'sender_user_id' => :'senderUserId', :'sent' => :'sent', :'submitted_date' => :'submittedDate' } end |
.swagger_types ⇒ Object
Attribute type mapping.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 82 def self.swagger_types { :'batch_id' => :'String', :'batch_name' => :'String', :'batch_size' => :'String', :'bulk_errors' => :'Array<BulkSendErrorStatus>', :'envelope_id_or_template_id' => :'String', :'envelopes_info' => :'BulkSendEnvelopesInfo', :'envelopes_uri' => :'String', :'failed' => :'String', :'mailing_list_id' => :'String', :'mailing_list_name' => :'String', :'owner_user_id' => :'String', :'queued' => :'String', :'sender_user_id' => :'String', :'sent' => :'String', :'submitted_date' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 188 def ==(o) return true if self.equal?(o) self.class == o.class && batch_id == o.batch_id && batch_name == o.batch_name && batch_size == o.batch_size && bulk_errors == o.bulk_errors && envelope_id_or_template_id == o.envelope_id_or_template_id && envelopes_info == o.envelopes_info && envelopes_uri == o.envelopes_uri && failed == o.failed && mailing_list_id == o.mailing_list_id && mailing_list_name == o.mailing_list_name && owner_user_id == o.owner_user_id && queued == o.queued && sender_user_id == o.sender_user_id && sent == o.sent && submitted_date == o.submitted_date end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 244 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
310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 310 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
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 223 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
210 211 212 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 210 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
216 217 218 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 216 def hash [batch_id, batch_name, batch_size, bulk_errors, envelope_id_or_template_id, envelopes_info, envelopes_uri, failed, mailing_list_id, mailing_list_name, owner_user_id, queued, sender_user_id, sent, submitted_date].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
175 176 177 178 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 175 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
290 291 292 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 290 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
296 297 298 299 300 301 302 303 304 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 296 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
284 285 286 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 284 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
182 183 184 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 182 def valid? true end |