Class: AdvancedBilling::SubscriptionGroupSingleError

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

Overview

SubscriptionGroupSingleError Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

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

Constructor Details

#initialize(subscription_group:, additional_properties: {}) ⇒ SubscriptionGroupSingleError

Returns a new instance of SubscriptionGroupSingleError.



33
34
35
36
37
38
39
40
# File 'lib/advanced_billing/models/subscription_group_single_error.rb', line 33

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

  @subscription_group = subscription_group
end

Instance Attribute Details

#subscription_groupString

TODO: Write general description for this method

Returns:

  • (String)


14
15
16
# File 'lib/advanced_billing/models/subscription_group_single_error.rb', line 14

def subscription_group
  @subscription_group
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/advanced_billing/models/subscription_group_single_error.rb', line 43

def self.from_hash(hash)
  return nil unless hash

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

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

  # Create object from extracted values.
  SubscriptionGroupSingleError.new(subscription_group: subscription_group,
                                   additional_properties: additional_properties)
end

.namesObject

A mapping from model property names to API property names.



17
18
19
20
21
# File 'lib/advanced_billing/models/subscription_group_single_error.rb', line 17

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

.nullablesObject

An array for nullable fields



29
30
31
# File 'lib/advanced_billing/models/subscription_group_single_error.rb', line 29

def self.nullables
  []
end

.optionalsObject

An array for optional fields



24
25
26
# File 'lib/advanced_billing/models/subscription_group_single_error.rb', line 24

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



60
61
62
63
64
65
66
67
68
69
70
# File 'lib/advanced_billing/models/subscription_group_single_error.rb', line 60

def self.validate(value)
  if value.instance_of? self
    return APIHelper.valid_type?(value.subscription_group,
                                 ->(val) { val.instance_of? String })
  end

  return false unless value.instance_of? Hash

  APIHelper.valid_type?(value['subscription_group'],
                        ->(val) { val.instance_of? String })
end