Class: DocuSign_eSign::BulkEnvelopeStatus
- Inherits:
-
Object
- Object
- DocuSign_eSign::BulkEnvelopeStatus
- Defined in:
- lib/docusign_esign/models/bulk_envelope_status.rb
Instance Attribute Summary collapse
-
#batch_id ⇒ Object
Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
-
#batch_size ⇒ Object
The number of items returned in this response.
-
#bulk_envelopes ⇒ Object
Reserved: TBD.
-
#bulk_envelopes_batch_uri ⇒ Object
Reserved: TBD.
-
#end_position ⇒ Object
The last position in the result set.
-
#failed ⇒ Object
The number of entries with a status of failed.
-
#next_uri ⇒ Object
The URI to the next chunk of records based on the search request.
-
#previous_uri ⇒ Object
The postal code for the billing address.
-
#queued ⇒ Object
The number of entries with a status of queued.
-
#result_set_size ⇒ Object
The number of results returned in this response.
-
#sent ⇒ Object
The number of entries with a status of sent.
-
#start_position ⇒ Object
Starting position of the current result set.
-
#submitted_date ⇒ Object
Returns the value of attribute submitted_date.
-
#total_set_size ⇒ Object
The total number of items available in the result set.
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 = {}) ⇒ BulkEnvelopeStatus
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 = {}) ⇒ BulkEnvelopeStatus
Initializes the object
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 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 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 102 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?(:'batchSize') self.batch_size = attributes[:'batchSize'] end if attributes.has_key?(:'bulkEnvelopes') if (value = attributes[:'bulkEnvelopes']).is_a?(Array) self.bulk_envelopes = value end end if attributes.has_key?(:'bulkEnvelopesBatchUri') self.bulk_envelopes_batch_uri = attributes[:'bulkEnvelopesBatchUri'] end if attributes.has_key?(:'endPosition') self.end_position = attributes[:'endPosition'] end if attributes.has_key?(:'failed') self.failed = attributes[:'failed'] end if attributes.has_key?(:'nextUri') self.next_uri = attributes[:'nextUri'] end if attributes.has_key?(:'previousUri') self.previous_uri = attributes[:'previousUri'] end if attributes.has_key?(:'queued') self.queued = attributes[:'queued'] end if attributes.has_key?(:'resultSetSize') self.result_set_size = attributes[:'resultSetSize'] end if attributes.has_key?(:'sent') self.sent = attributes[:'sent'] end if attributes.has_key?(:'startPosition') self.start_position = attributes[:'startPosition'] end if attributes.has_key?(:'submittedDate') self.submitted_date = attributes[:'submittedDate'] end if attributes.has_key?(:'totalSetSize') self.total_set_size = attributes[:'totalSetSize'] end end |
Instance Attribute Details
#batch_id ⇒ Object
Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
18 19 20 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 18 def batch_id @batch_id end |
#batch_size ⇒ Object
The number of items returned in this response.
21 22 23 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 21 def batch_size @batch_size end |
#bulk_envelopes ⇒ Object
Reserved: TBD
24 25 26 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 24 def bulk_envelopes @bulk_envelopes end |
#bulk_envelopes_batch_uri ⇒ Object
Reserved: TBD
27 28 29 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 27 def bulk_envelopes_batch_uri @bulk_envelopes_batch_uri end |
#end_position ⇒ Object
The last position in the result set.
30 31 32 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 30 def end_position @end_position end |
#failed ⇒ Object
The number of entries with a status of failed.
33 34 35 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 33 def failed @failed end |
#next_uri ⇒ Object
The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.
36 37 38 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 36 def next_uri @next_uri end |
#previous_uri ⇒ Object
The postal code for the billing address.
39 40 41 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 39 def previous_uri @previous_uri end |
#queued ⇒ Object
The number of entries with a status of queued.
42 43 44 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 42 def queued @queued end |
#result_set_size ⇒ Object
The number of results returned in this response.
45 46 47 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 45 def result_set_size @result_set_size end |
#sent ⇒ Object
The number of entries with a status of sent.
48 49 50 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 48 def sent @sent end |
#start_position ⇒ Object
Starting position of the current result set.
51 52 53 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 51 def start_position @start_position end |
#submitted_date ⇒ Object
Returns the value of attribute submitted_date.
54 55 56 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 54 def submitted_date @submitted_date end |
#total_set_size ⇒ Object
The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.
57 58 59 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 57 def total_set_size @total_set_size 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 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 61 def self.attribute_map { :'batch_id' => :'batchId', :'batch_size' => :'batchSize', :'bulk_envelopes' => :'bulkEnvelopes', :'bulk_envelopes_batch_uri' => :'bulkEnvelopesBatchUri', :'end_position' => :'endPosition', :'failed' => :'failed', :'next_uri' => :'nextUri', :'previous_uri' => :'previousUri', :'queued' => :'queued', :'result_set_size' => :'resultSetSize', :'sent' => :'sent', :'start_position' => :'startPosition', :'submitted_date' => :'submittedDate', :'total_set_size' => :'totalSetSize' } end |
.swagger_types ⇒ Object
Attribute type mapping.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 81 def self.swagger_types { :'batch_id' => :'String', :'batch_size' => :'String', :'bulk_envelopes' => :'Array<BulkEnvelope>', :'bulk_envelopes_batch_uri' => :'String', :'end_position' => :'String', :'failed' => :'String', :'next_uri' => :'String', :'previous_uri' => :'String', :'queued' => :'String', :'result_set_size' => :'String', :'sent' => :'String', :'start_position' => :'String', :'submitted_date' => :'String', :'total_set_size' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 183 def ==(o) return true if self.equal?(o) self.class == o.class && batch_id == o.batch_id && batch_size == o.batch_size && bulk_envelopes == o.bulk_envelopes && bulk_envelopes_batch_uri == o.bulk_envelopes_batch_uri && end_position == o.end_position && failed == o.failed && next_uri == o.next_uri && previous_uri == o.previous_uri && queued == o.queued && result_set_size == o.result_set_size && sent == o.sent && start_position == o.start_position && submitted_date == o.submitted_date && total_set_size == o.total_set_size end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
238 239 240 241 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 267 268 269 270 271 272 273 274 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 238 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
304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 304 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
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 217 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 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
204 205 206 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 204 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
210 211 212 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 210 def hash [batch_id, batch_size, bulk_envelopes, bulk_envelopes_batch_uri, end_position, failed, next_uri, previous_uri, queued, result_set_size, sent, start_position, submitted_date, total_set_size].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
170 171 172 173 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 170 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
284 285 286 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 284 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
290 291 292 293 294 295 296 297 298 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 290 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
278 279 280 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 278 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
177 178 179 |
# File 'lib/docusign_esign/models/bulk_envelope_status.rb', line 177 def valid? return true end |