Class: AdvancedBilling::Metafield

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

Overview

Metafield Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(id: SKIP, name: SKIP, scope: SKIP, data_count: SKIP, input_type: SKIP, enum: SKIP, additional_properties: {}) ⇒ Metafield

Returns a new instance of Metafield.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/advanced_billing/models/metafield.rb', line 77

def initialize(id: SKIP, name: SKIP, scope: SKIP, data_count: SKIP,
               input_type: SKIP, enum: SKIP, additional_properties: {})
  @id = id unless id == SKIP
  @name = name unless name == SKIP
  @scope = scope unless scope == SKIP
  @data_count = data_count unless data_count == SKIP
  @input_type = input_type unless input_type == SKIP
  @enum = enum unless enum == SKIP

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

Instance Attribute Details

#data_count ⇒ Integer

the amount of subscriptions this metafield has been applied to in Chargify

Returns:

  • (Integer) 


28
29
30
 
# File 'lib/advanced_billing/models/metafield.rb', line 28

def data_count
  @data_count
end

#enum ⇒ Object

Indicates how data should be added to the metafield. For example, a text type is just a string, so a given metafield of this type can have any value attached. On the other hand, dropdown and radio have a set of allowed values that can be input, and appear differently on a Public Signup Page. Defaults to ‘text’

Returns:

  • (Object) 


44
45
46
 
# File 'lib/advanced_billing/models/metafield.rb', line 44

def enum
  @enum
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def id
  @id
end

#input_type ⇒ MetafieldInput

Indicates how data should be added to the metafield. For example, a text type is just a string, so a given metafield of this type can have any value attached. On the other hand, dropdown and radio have a set of allowed values that can be input, and appear differently on a Public Signup Page. Defaults to ‘text’

Returns:



36
37
38
 
# File 'lib/advanced_billing/models/metafield.rb', line 36

def input_type
  @input_type
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/advanced_billing/models/metafield.rb', line 18

def name
  @name
end

#scope ⇒ MetafieldScope

Warning: When updating a metafield’s scope attribute, all scope attributes must be passed. Partially complete scope attributes will override the existing settings.

Returns:



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

def scope
  @scope
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/advanced_billing/models/metafield.rb', line 93

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : SKIP
  name = hash.key?('name') ? hash['name'] : SKIP
  scope = MetafieldScope.from_hash(hash['scope']) if hash['scope']
  data_count = hash.key?('data_count') ? hash['data_count'] : SKIP
  input_type = hash.key?('input_type') ? hash['input_type'] : SKIP
  enum = hash.key?('enum') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:MetafieldEnum), hash['enum']
  ) : SKIP

  # Clean out expected properties from Hash.
  names.each_value { |k| hash.delete(k) }

  # Create object from extracted values.
  Metafield.new(id: id,
                name: name,
                scope: scope,
                data_count: data_count,
                input_type: input_type,
                enum: enum,
                additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/advanced_billing/models/metafield.rb', line 47

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['name'] = 'name'
  @_hash['scope'] = 'scope'
  @_hash['data_count'] = 'data_count'
  @_hash['input_type'] = 'input_type'
  @_hash['enum'] = 'enum'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



71
72
73
74
75
 
# File 'lib/advanced_billing/models/metafield.rb', line 71

def self.nullables
  %w[
    enum
  ]
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    id
    name
    scope
    data_count
    input_type
    enum
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (Metafield | Hash) —

    value against the validation is performed.



121
122
123
124
125
126
127
 
# File 'lib/advanced_billing/models/metafield.rb', line 121

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end