Class: SwaggerClient::ClientService

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/models/client_service.rb

Overview

A service that is on a client’s account.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClientService

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/swagger_client/models/client_service.rb', line 109

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

  if attributes.has_key?(:'Count')
    self.count = attributes[:'Count']
  end

  if attributes.has_key?(:'Current')
    self.current = attributes[:'Current']
  end

  if attributes.has_key?(:'ExpirationDate')
    self.expiration_date = attributes[:'ExpirationDate']
  end

  if attributes.has_key?(:'Id')
    self.id = attributes[:'Id']
  end

  if attributes.has_key?(:'Name')
    self.name = attributes[:'Name']
  end

  if attributes.has_key?(:'PaymentDate')
    self.payment_date = attributes[:'PaymentDate']
  end

  if attributes.has_key?(:'Program')
    self.program = attributes[:'Program']
  end

  if attributes.has_key?(:'Remaining')
    self.remaining = attributes[:'Remaining']
  end

  if attributes.has_key?(:'SiteId')
    self.site_id = attributes[:'SiteId']
  end

  if attributes.has_key?(:'Action')
    self.action = attributes[:'Action']
  end
end

Instance Attribute Details

#action ⇒ Object

The action taken.



49
50
51
 
# File 'lib/swagger_client/models/client_service.rb', line 49

def action
  @action
end

#active_date ⇒ Object

The date that this pricing option became active and could be used to pay for services.



19
20
21
 
# File 'lib/swagger_client/models/client_service.rb', line 19

def active_date
  @active_date
end

#count ⇒ Object

The number of service sessions this pricing option contained when first purchased.



22
23
24
 
# File 'lib/swagger_client/models/client_service.rb', line 22

def count
  @count
end

#current ⇒ Object

When ‘true`, there are service sessions remaining on the pricing option that can be used pay for the current session.<br /> When `false`, the client cannot use this pricing option to pay for other services.



25
26
27
 
# File 'lib/swagger_client/models/client_service.rb', line 25

def current
  @current
end

#expiration_date ⇒ Object

The date when the pricing option expires and can no longer be used to pay for services, even if unused service sessions remain on the option; expressed as UTC.



28
29
30
 
# File 'lib/swagger_client/models/client_service.rb', line 28

def expiration_date
  @expiration_date
end

#id ⇒ Object

The unique ID assigned to this pricing option.



31
32
33
 
# File 'lib/swagger_client/models/client_service.rb', line 31

def id
  @id
end

#name ⇒ Object

The name of this pricing option.



34
35
36
 
# File 'lib/swagger_client/models/client_service.rb', line 34

def name
  @name
end

#payment_date ⇒ Object

The date on which the client paid for this pricing option.



37
38
39
 
# File 'lib/swagger_client/models/client_service.rb', line 37

def payment_date
  @payment_date
end

#program ⇒ Object

Contains information about the service category this service falls under.



40
41
42
 
# File 'lib/swagger_client/models/client_service.rb', line 40

def program
  @program
end

#remaining ⇒ Object

The number of service sessions remaining in the pricing option that can still be used.



43
44
45
 
# File 'lib/swagger_client/models/client_service.rb', line 43

def remaining
  @remaining
end

#site_id ⇒ Object

The ID of the subscriber site associated with this pricing option.



46
47
48
 
# File 'lib/swagger_client/models/client_service.rb', line 46

def site_id
  @site_id
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/swagger_client/models/client_service.rb', line 74

def self.attribute_map
  {
    :'active_date' => :'ActiveDate',
    :'count' => :'Count',
    :'current' => :'Current',
    :'expiration_date' => :'ExpirationDate',
    :'id' => :'Id',
    :'name' => :'Name',
    :'payment_date' => :'PaymentDate',
    :'program' => :'Program',
    :'remaining' => :'Remaining',
    :'site_id' => :'SiteId',
    :'action' => :'Action'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/swagger_client/models/client_service.rb', line 91

def self.swagger_types
  {
    :'active_date' => :'DateTime',
    :'count' => :'Integer',
    :'current' => :'BOOLEAN',
    :'expiration_date' => :'DateTime',
    :'id' => :'Integer',
    :'name' => :'String',
    :'payment_date' => :'DateTime',
    :'program' => :'Program',
    :'remaining' => :'Integer',
    :'site_id' => :'Integer',
    :'action' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/swagger_client/models/client_service.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active_date == o.active_date &&
      count == o.count &&
      current == o.current &&
      expiration_date == o.expiration_date &&
      id == o.id &&
      name == o.name &&
      payment_date == o.payment_date &&
      program == o.program &&
      remaining == o.remaining &&
      site_id == o.site_id &&
      action == o.action
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



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
275
 
# File 'lib/swagger_client/models/client_service.rb', line 239

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 = SwaggerClient.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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/swagger_client/models/client_service.rb', line 305

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/swagger_client/models/client_service.rb', line 218

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


205
206
207
 
# File 'lib/swagger_client/models/client_service.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/swagger_client/models/client_service.rb', line 211

def hash
  [active_date, count, current, expiration_date, id, name, payment_date, program, remaining, site_id, action].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



162
163
164
165
 
# File 'lib/swagger_client/models/client_service.rb', line 162

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



285
286
287
 
# File 'lib/swagger_client/models/client_service.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/swagger_client/models/client_service.rb', line 291

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



279
280
281
 
# File 'lib/swagger_client/models/client_service.rb', line 279

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



169
170
171
172
173
 
# File 'lib/swagger_client/models/client_service.rb', line 169

def valid?
  action_validator = EnumAttributeValidator.new('String', ['None', 'Added', 'Updated', 'Failed', 'Removed'])
  return false unless action_validator.valid?(@action)
  true
end