Class: AdvancedBilling::ListMrrFilter

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/advanced_billing/models/list_mrr_filter.rb

Overview

ListMrrFilter Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #get_additional_properties, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(subscription_ids: SKIP, additional_properties: {}) ⇒ ListMrrFilter

Returns a new instance of ListMrrFilter.



36
37
38
39
40
41
42
43
 
# File 'lib/advanced_billing/models/list_mrr_filter.rb', line 36

def initialize(subscription_ids: SKIP, additional_properties: {})
  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @subscription_ids = subscription_ids unless subscription_ids == SKIP
end

Instance Attribute Details

#subscription_ids ⇒ Array[Integer]

Submit ids in order to limit results. Use in query: ‘filter=1,2,3`.

Returns:

  • (Array[Integer]) 


15
16
17
 
# File 'lib/advanced_billing/models/list_mrr_filter.rb', line 15

def subscription_ids
  @subscription_ids
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/advanced_billing/models/list_mrr_filter.rb', line 46

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  subscription_ids =
    hash.key?('subscription_ids') ? hash['subscription_ids'] : SKIP

  # Clean out expected properties from Hash.
  additional_properties = hash.reject { |k, _| names.value?(k) }

  # Create object from extracted values.
  ListMrrFilter.new(subscription_ids: subscription_ids,
                    additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
 
# File 'lib/advanced_billing/models/list_mrr_filter.rb', line 18

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['subscription_ids'] = 'subscription_ids'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



32
33
34
 
# File 'lib/advanced_billing/models/list_mrr_filter.rb', line 32

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



25
26
27
28
29
 
# File 'lib/advanced_billing/models/list_mrr_filter.rb', line 25

def self.optionals
  %w[
    subscription_ids
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



69
70
71
72
73
 
# File 'lib/advanced_billing/models/list_mrr_filter.rb', line 69

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} subscription_ids: #{@subscription_ids.inspect}, additional_properties:"\
  " #{get_additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



62
63
64
65
66
 
# File 'lib/advanced_billing/models/list_mrr_filter.rb', line 62

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} subscription_ids: #{@subscription_ids}, additional_properties:"\
  " #{get_additional_properties}>"
end