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_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.
-
#queued ⇒ Object
Returns the value of attribute queued.
-
#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
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 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 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 86 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?(:'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?(:'queued') self.queued = attributes[:'queued'] 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.
18 19 20 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 18 def batch_id @batch_id end |
#batch_name ⇒ Object
Returns the value of attribute batch_name.
21 22 23 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 21 def batch_name @batch_name end |
#batch_size ⇒ Object
Returns the value of attribute batch_size.
24 25 26 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 24 def batch_size @batch_size end |
#bulk_errors ⇒ Object
Returns the value of attribute bulk_errors.
27 28 29 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 27 def bulk_errors @bulk_errors end |
#envelope_id_or_template_id ⇒ Object
Returns the value of attribute envelope_id_or_template_id.
30 31 32 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 30 def envelope_id_or_template_id @envelope_id_or_template_id end |
#envelopes_uri ⇒ Object
Returns the value of attribute envelopes_uri.
33 34 35 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 33 def envelopes_uri @envelopes_uri end |
#failed ⇒ Object
Returns the value of attribute failed.
36 37 38 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 36 def failed @failed end |
#mailing_list_id ⇒ Object
Returns the value of attribute mailing_list_id.
39 40 41 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 39 def mailing_list_id @mailing_list_id end |
#queued ⇒ Object
Returns the value of attribute queued.
42 43 44 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 42 def queued @queued end |
#sent ⇒ Object
Returns the value of attribute sent.
45 46 47 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 45 def sent @sent end |
#submitted_date ⇒ Object
Returns the value of attribute submitted_date.
48 49 50 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 48 def submitted_date @submitted_date end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 51 def self.attribute_map { :'batch_id' => :'batchId', :'batch_name' => :'batchName', :'batch_size' => :'batchSize', :'bulk_errors' => :'bulkErrors', :'envelope_id_or_template_id' => :'envelopeIdOrTemplateId', :'envelopes_uri' => :'envelopesUri', :'failed' => :'failed', :'mailing_list_id' => :'mailingListId', :'queued' => :'queued', :'sent' => :'sent', :'submitted_date' => :'submittedDate' } end |
.swagger_types ⇒ Object
Attribute type mapping.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 68 def self.swagger_types { :'batch_id' => :'String', :'batch_name' => :'String', :'batch_size' => :'String', :'bulk_errors' => :'Array<BulkSendErrorStatus>', :'envelope_id_or_template_id' => :'String', :'envelopes_uri' => :'String', :'failed' => :'String', :'mailing_list_id' => :'String', :'queued' => :'String', :'sent' => :'String', :'submitted_date' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 154 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_uri == o.envelopes_uri && failed == o.failed && mailing_list_id == o.mailing_list_id && queued == o.queued && sent == o.sent && submitted_date == o.submitted_date end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 206 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
272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 272 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
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 185 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
172 173 174 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 172 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
178 179 180 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 178 def hash [batch_id, batch_name, batch_size, bulk_errors, envelope_id_or_template_id, envelopes_uri, failed, mailing_list_id, queued, sent, submitted_date].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
141 142 143 144 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 141 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
252 253 254 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 252 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
258 259 260 261 262 263 264 265 266 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 258 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
246 247 248 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 246 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
148 149 150 |
# File 'lib/docusign_esign/models/bulk_send_batch_status.rb', line 148 def valid? true end |