Class: DocuSign_eSign::UsageHistory

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

Overview

A complex element consisting of: * lastSentDateTime - the date and time the user last sent an envelope. * lastSignedDateTime - the date and time the user last signed an envelope. * sentCount - the number of envelopes the user has sent. * signedCount - the number of envelopes the user has signed.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UsageHistory

Initializes the object

Parameters:

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

    Model attributes in the form of hash


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/docusign_esign/models/usage_history.rb', line 52

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

  if attributes.has_key?(:'lastSignedDateTime')
    self.last_signed_date_time = attributes[:'lastSignedDateTime']
  end

  if attributes.has_key?(:'sentCount')
    self.sent_count = attributes[:'sentCount']
  end

  if attributes.has_key?(:'signedCount')
    self.signed_count = attributes[:'signedCount']
  end
end

Instance Attribute Details

#last_sent_date_timeObject

The date and time the user last sent an envelope.


19
20
21
# File 'lib/docusign_esign/models/usage_history.rb', line 19

def last_sent_date_time
  @last_sent_date_time
end

#last_signed_date_timeObject

The date and time the user last signed an envelope.


22
23
24
# File 'lib/docusign_esign/models/usage_history.rb', line 22

def last_signed_date_time
  @last_signed_date_time
end

#sent_countObject

The number of envelopes the user has sent.


25
26
27
# File 'lib/docusign_esign/models/usage_history.rb', line 25

def sent_count
  @sent_count
end

#signed_countObject

The number of envelopes the user has signed.


28
29
30
# File 'lib/docusign_esign/models/usage_history.rb', line 28

def signed_count
  @signed_count
end

Class Method Details

.attribute_mapObject

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


31
32
33
34
35
36
37
38
# File 'lib/docusign_esign/models/usage_history.rb', line 31

def self.attribute_map
  {
    :'last_sent_date_time' => :'lastSentDateTime',
    :'last_signed_date_time' => :'lastSignedDateTime',
    :'sent_count' => :'sentCount',
    :'signed_count' => :'signedCount'
  }
end

.swagger_typesObject

Attribute type mapping.


41
42
43
44
45
46
47
48
# File 'lib/docusign_esign/models/usage_history.rb', line 41

def self.swagger_types
  {
    :'last_sent_date_time' => :'String',
    :'last_signed_date_time' => :'String',
    :'sent_count' => :'String',
    :'signed_count' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


90
91
92
93
94
95
96
97
# File 'lib/docusign_esign/models/usage_history.rb', line 90

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      last_sent_date_time == o.last_sent_date_time &&
      last_signed_date_time == o.last_signed_date_time &&
      sent_count == o.sent_count &&
      signed_count == o.signed_count
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


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
# File 'lib/docusign_esign/models/usage_history.rb', line 135

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


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

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


114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/docusign_esign/models/usage_history.rb', line 114

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

101
102
103
# File 'lib/docusign_esign/models/usage_history.rb', line 101

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


107
108
109
# File 'lib/docusign_esign/models/usage_history.rb', line 107

def hash
  [last_sent_date_time, last_signed_date_time, sent_count, signed_count].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


77
78
79
80
# File 'lib/docusign_esign/models/usage_history.rb', line 77

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


181
182
183
# File 'lib/docusign_esign/models/usage_history.rb', line 181

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


187
188
189
190
191
192
193
194
195
# File 'lib/docusign_esign/models/usage_history.rb', line 187

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


175
176
177
# File 'lib/docusign_esign/models/usage_history.rb', line 175

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


84
85
86
# File 'lib/docusign_esign/models/usage_history.rb', line 84

def valid?
  true
end