Class: DocuSign_eSign::BulkSendBatchSummaries

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/bulk_send_batch_summaries.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkSendBatchSummaries

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 81

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?(:'batchSizeLimit')
    self.batch_size_limit = attributes[:'batchSizeLimit']
  end

  if attributes.has_key?(:'bulkBatchSummaries')
    if (value = attributes[:'bulkBatchSummaries']).is_a?(Array)
      self.bulk_batch_summaries = value
    end
  end

  if attributes.has_key?(:'endPosition')
    self.end_position = attributes[:'endPosition']
  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?(:'queueLimit')
    self.queue_limit = attributes[:'queueLimit']
  end

  if attributes.has_key?(:'resultSetSize')
    self.result_set_size = attributes[:'resultSetSize']
  end

  if attributes.has_key?(:'startPosition')
    self.start_position = attributes[:'startPosition']
  end

  if attributes.has_key?(:'totalQueued')
    self.total_queued = attributes[:'totalQueued']
  end

  if attributes.has_key?(:'totalSetSize')
    self.total_set_size = attributes[:'totalSetSize']
  end
end

Instance Attribute Details

#batch_size_limitObject

Returns the value of attribute batch_size_limit


18
19
20
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 18

def batch_size_limit
  @batch_size_limit
end

#bulk_batch_summariesObject

Returns the value of attribute bulk_batch_summaries


21
22
23
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 21

def bulk_batch_summaries
  @bulk_batch_summaries
end

#end_positionObject

The last position in the result set.


24
25
26
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 24

def end_position
  @end_position
end

#next_uriObject

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.


27
28
29
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 27

def next_uri
  @next_uri
end

#previous_uriObject

The postal code for the billing address.


30
31
32
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 30

def previous_uri
  @previous_uri
end

#queue_limitObject

Returns the value of attribute queue_limit


33
34
35
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 33

def queue_limit
  @queue_limit
end

#result_set_sizeObject

The number of results returned in this response.


36
37
38
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 36

def result_set_size
  @result_set_size
end

#start_positionObject

Starting position of the current result set.


39
40
41
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 39

def start_position
  @start_position
end

#total_queuedObject

Returns the value of attribute total_queued


42
43
44
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 42

def total_queued
  @total_queued
end

#total_set_sizeObject

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.


45
46
47
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 45

def total_set_size
  @total_set_size
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.


48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 48

def self.attribute_map
  {
    :'batch_size_limit' => :'batchSizeLimit',
    :'bulk_batch_summaries' => :'bulkBatchSummaries',
    :'end_position' => :'endPosition',
    :'next_uri' => :'nextUri',
    :'previous_uri' => :'previousUri',
    :'queue_limit' => :'queueLimit',
    :'result_set_size' => :'resultSetSize',
    :'start_position' => :'startPosition',
    :'total_queued' => :'totalQueued',
    :'total_set_size' => :'totalSetSize'
  }
end

.swagger_typesObject

Attribute type mapping.


64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 64

def self.swagger_types
  {
    :'batch_size_limit' => :'String',
    :'bulk_batch_summaries' => :'Array<BulkSendBatchSummary>',
    :'end_position' => :'String',
    :'next_uri' => :'String',
    :'previous_uri' => :'String',
    :'queue_limit' => :'String',
    :'result_set_size' => :'String',
    :'start_position' => :'String',
    :'total_queued' => :'String',
    :'total_set_size' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 145

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      batch_size_limit == o.batch_size_limit &&
      bulk_batch_summaries == o.bulk_batch_summaries &&
      end_position == o.end_position &&
      next_uri == o.next_uri &&
      previous_uri == o.previous_uri &&
      queue_limit == o.queue_limit &&
      result_set_size == o.result_set_size &&
      start_position == o.start_position &&
      total_queued == o.total_queued &&
      total_set_size == o.total_set_size
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


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
226
227
228
229
230
231
232
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 196

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 262

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

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 175

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

162
163
164
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 162

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


168
169
170
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 168

def hash
  [batch_size_limit, bulk_batch_summaries, end_position, next_uri, previous_uri, queue_limit, result_set_size, start_position, total_queued, total_set_size].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


132
133
134
135
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 132

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


242
243
244
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 242

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


248
249
250
251
252
253
254
255
256
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 248

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


236
237
238
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 236

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


139
140
141
# File 'lib/docusign_esign/models/bulk_send_batch_summaries.rb', line 139

def valid?
  true
end