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
-
#action ⇒ Object
Returns the value of attribute action.
-
#action_status ⇒ Object
Returns the value of attribute action_status.
-
#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.
-
#resends_remaining ⇒ Object
Returns the value of attribute resends_remaining.
-
#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
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 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 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 119 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?(:'action') self.action = attributes[:'action'] end if attributes.has_key?(:'actionStatus') self.action_status = attributes[:'actionStatus'] end 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?(:'resendsRemaining') self.resends_remaining = attributes[:'resendsRemaining'] 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
#action ⇒ Object
Returns the value of attribute action.
17 18 19 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 17 def action @action end |
#action_status ⇒ Object
Returns the value of attribute action_status.
20 21 22 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 20 def action_status @action_status end |
#batch_id ⇒ Object
Returns the value of attribute batch_id.
23 24 25 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 23 def batch_id @batch_id end |
#batch_name ⇒ Object
Returns the value of attribute batch_name.
26 27 28 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 26 def batch_name @batch_name end |
#batch_size ⇒ Object
Returns the value of attribute batch_size.
29 30 31 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 29 def batch_size @batch_size end |
#bulk_errors ⇒ Object
Returns the value of attribute bulk_errors.
32 33 34 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 32 def bulk_errors @bulk_errors end |
#envelope_id_or_template_id ⇒ Object
Returns the value of attribute envelope_id_or_template_id.
35 36 37 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 35 def envelope_id_or_template_id @envelope_id_or_template_id end |
#envelopes_info ⇒ Object
Returns the value of attribute envelopes_info.
37 38 39 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 37 def envelopes_info @envelopes_info end |
#envelopes_uri ⇒ Object
Returns the value of attribute envelopes_uri.
40 41 42 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 40 def envelopes_uri @envelopes_uri end |
#failed ⇒ Object
Returns the value of attribute failed.
43 44 45 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 43 def failed @failed end |
#mailing_list_id ⇒ Object
Returns the value of attribute mailing_list_id.
46 47 48 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 46 def mailing_list_id @mailing_list_id end |
#mailing_list_name ⇒ Object
Returns the value of attribute mailing_list_name.
49 50 51 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 49 def mailing_list_name @mailing_list_name end |
#owner_user_id ⇒ Object
Returns the value of attribute owner_user_id.
52 53 54 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 52 def owner_user_id @owner_user_id end |
#queued ⇒ Object
Returns the value of attribute queued.
55 56 57 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 55 def queued @queued end |
#resends_remaining ⇒ Object
Returns the value of attribute resends_remaining.
58 59 60 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 58 def resends_remaining @resends_remaining end |
#sender_user_id ⇒ Object
Returns the value of attribute sender_user_id.
61 62 63 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 61 def sender_user_id @sender_user_id end |
#sent ⇒ Object
Returns the value of attribute sent.
64 65 66 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 64 def sent @sent end |
#submitted_date ⇒ Object
Returns the value of attribute submitted_date.
67 68 69 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 67 def submitted_date @submitted_date end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 70 def self.attribute_map { :'action' => :'action', :'action_status' => :'actionStatus', :'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', :'resends_remaining' => :'resendsRemaining', :'sender_user_id' => :'senderUserId', :'sent' => :'sent', :'submitted_date' => :'submittedDate' } end |
.swagger_types ⇒ Object
Attribute type mapping.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 94 def self.swagger_types { :'action' => :'String', :'action_status' => :'String', :'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', :'resends_remaining' => :'String', :'sender_user_id' => :'String', :'sent' => :'String', :'submitted_date' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 215 def ==(o) return true if self.equal?(o) self.class == o.class && action == o.action && action_status == o.action_status && 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 && resends_remaining == o.resends_remaining && 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
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 274 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
340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 340 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
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 253 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
240 241 242 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 240 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
246 247 248 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 246 def hash [action, action_status, 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, resends_remaining, sender_user_id, sent, submitted_date].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
202 203 204 205 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 202 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
320 321 322 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 320 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
326 327 328 329 330 331 332 333 334 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 326 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
314 315 316 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 314 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
209 210 211 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 209 def valid? true end |