Class: DocuSign_eSign::EnvelopesInformation

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

Overview

Result set for the Envelopes: listStatusChanges method

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopesInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 91

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

  if attributes.has_key?(:'endPosition')
    self.end_position = attributes[:'endPosition']
  end

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

  if attributes.has_key?(:'envelopeSearchSource')
    self.envelope_search_source = attributes[:'envelopeSearchSource']
  end

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

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

  if attributes.has_key?(:'lastQueriedDateTime')
    self.last_queried_date_time = attributes[:'lastQueriedDateTime']
  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?(:'resultSetSize')
    self.result_set_size = attributes[:'resultSetSize']
  end

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

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

Instance Attribute Details

#continuation_token ⇒ Object

Returns the value of attribute continuation_token.



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

def continuation_token
  @continuation_token
end

#end_position ⇒ Object

The last position in the result set.



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

def end_position
  @end_position
end

#envelope_search_source ⇒ Object

Returns the value of attribute envelope_search_source.



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

def envelope_search_source
  @envelope_search_source
end

#envelope_transaction_statuses ⇒ Object

Returns the value of attribute envelope_transaction_statuses.



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

def envelope_transaction_statuses
  @envelope_transaction_statuses
end

#envelopes ⇒ Object

Returns the value of attribute envelopes.



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

def envelopes
  @envelopes
end

#folders ⇒ Object

Returns the value of attribute folders.



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

def folders
  @folders
end

#last_queried_date_time ⇒ Object

Returns the value of attribute last_queried_date_time.



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

def last_queried_date_time
  @last_queried_date_time
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.



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

def next_uri
  @next_uri
end

#previous_uri ⇒ Object

The postal code for the billing address.



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

def previous_uri
  @previous_uri
end

#result_set_size ⇒ Object

The number of results returned in this response.



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

def result_set_size
  @result_set_size
end

#start_position ⇒ Object

Starting position of the current result set.



48
49
50
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 48

def start_position
  @start_position
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.



51
52
53
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 51

def total_set_size
  @total_set_size
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 54

def self.attribute_map
  {
    :'continuation_token' => :'continuationToken',
    :'end_position' => :'endPosition',
    :'envelopes' => :'envelopes',
    :'envelope_search_source' => :'envelopeSearchSource',
    :'envelope_transaction_statuses' => :'envelopeTransactionStatuses',
    :'folders' => :'folders',
    :'last_queried_date_time' => :'lastQueriedDateTime',
    :'next_uri' => :'nextUri',
    :'previous_uri' => :'previousUri',
    :'result_set_size' => :'resultSetSize',
    :'start_position' => :'startPosition',
    :'total_set_size' => :'totalSetSize'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 72

def self.swagger_types
  {
    :'continuation_token' => :'String',
    :'end_position' => :'String',
    :'envelopes' => :'Array<Envelope>',
    :'envelope_search_source' => :'String',
    :'envelope_transaction_statuses' => :'Array<EnvelopeTransactionStatus>',
    :'folders' => :'Array<Folder>',
    :'last_queried_date_time' => :'String',
    :'next_uri' => :'String',
    :'previous_uri' => :'String',
    :'result_set_size' => :'String',
    :'start_position' => :'String',
    :'total_set_size' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      continuation_token == o.continuation_token &&
      end_position == o.end_position &&
      envelopes == o.envelopes &&
      envelope_search_source == o.envelope_search_source &&
      envelope_transaction_statuses == o.envelope_transaction_statuses &&
      folders == o.folders &&
      last_queried_date_time == o.last_queried_date_time &&
      next_uri == o.next_uri &&
      previous_uri == o.previous_uri &&
      result_set_size == o.result_set_size &&
      start_position == o.start_position &&
      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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 220

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



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 286

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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 199

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


186
187
188
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 186

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



192
193
194
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 192

def hash
  [continuation_token, end_position, envelopes, envelope_search_source, envelope_transaction_statuses, folders, last_queried_date_time, next_uri, previous_uri, result_set_size, start_position, total_set_size].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



154
155
156
157
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 154

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 266

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



272
273
274
275
276
277
278
279
280
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 272

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

Returns:

  • (String) —

    String presentation of the object



260
261
262
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 260

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



161
162
163
 
# File 'lib/docusign_esign/models/envelopes_information.rb', line 161

def valid?
  true
end