Class: PostfinancecheckoutRubySdk::SubscriptionMetricUsageReportCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb

Overview

The metric usage is the actual usage of a metric for a particular subscription as collected by an external application.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionMetricUsageReportCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 84

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::SubscriptionMetricUsageReportCreate` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::SubscriptionMetricUsageReportCreate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'consumed_units')
    self.consumed_units = attributes[:'consumed_units']
  else
    self.consumed_units = nil
  end

  if attributes.key?(:'metric')
    self.metric = attributes[:'metric']
  else
    self.metric = nil
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  else
    self.external_id = nil
  end

  if attributes.key?(:'subscription')
    self.subscription = attributes[:'subscription']
  else
    self.subscription = nil
  end
end

Instance Attribute Details

#consumed_units ⇒ Object

The number of resources consumed, will be charged in the next billing cycle.



30
31
32
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 30

def consumed_units
  @consumed_units
end

#description ⇒ Object

A description used to identify the usage report.



36
37
38
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 36

def description
  @description
end

#external_id ⇒ Object

A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.



39
40
41
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 39

def external_id
  @external_id
end

#metric ⇒ Object

The metric that the usage report is recorded for.



33
34
35
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 33

def metric
  @metric
end

#subscription ⇒ Object

The subscription that the usage report is recorded for.



42
43
44
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 42

def subscription
  @subscription
end

Class Method Details

._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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 272

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = PostfinancecheckoutRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



56
57
58
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 56

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 61

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 45

def self.attribute_map
  {
    :'consumed_units' => :'consumedUnits',
    :'metric' => :'metric',
    :'description' => :'description',
    :'external_id' => :'externalId',
    :'subscription' => :'subscription'
  }
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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 248

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 77

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 66

def self.openapi_types
  {
    :'consumed_units' => :'Float',
    :'metric' => :'Integer',
    :'description' => :'String',
    :'external_id' => :'String',
    :'subscription' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



223
224
225
226
227
228
229
230
231
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      consumed_units == o.consumed_units &&
      metric == o.metric &&
      description == o.description &&
      external_id == o.external_id &&
      subscription == o.subscription
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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 343

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


235
236
237
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 241

def hash
  [consumed_units, metric, description, external_id, subscription].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



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 129

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @consumed_units.nil?
    invalid_properties.push('invalid value for "consumed_units", consumed_units cannot be nil.')
  end

  if @metric.nil?
    invalid_properties.push('invalid value for "metric", metric cannot be nil.')
  end

  if !@description.nil? && @description.to_s.length > 100
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100.')
  end

  if @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  end

  if @subscription.nil?
    invalid_properties.push('invalid value for "subscription", subscription cannot be nil.')
  end

  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



319
320
321
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 319

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 325

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



313
314
315
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 313

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



157
158
159
160
161
162
163
164
165
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 157

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @consumed_units.nil?
  return false if @metric.nil?
  return false if !@description.nil? && @description.to_s.length > 100
  return false if @external_id.nil?
  return false if @subscription.nil?
  true
end