Class: AdvancedBilling::Metafields

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

Overview

Metafields 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, input_type = MetafieldInput::TEXT, enum = SKIP) ⇒ Metafields

Returns a new instance of Metafields.



65
66
67
68
69
70
71
72
 
# File 'lib/advanced_billing/models/metafields.rb', line 65

def initialize(id = SKIP, name = SKIP, scope = SKIP,
               input_type = MetafieldInput::TEXT, enum = SKIP)
  @id = id unless id == SKIP
  @name = name unless name == SKIP
  @scope = scope unless scope == SKIP
  @input_type = input_type unless input_type == SKIP
  @enum = enum unless enum == SKIP
end

Instance Attribute Details

#enum ⇒ Array[String]

Only applicable when input_type is radio or dropdown

Returns:

  • (Array[String]) 


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

def enum
  @enum
end

#id ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


14
15
16
 
# File 'lib/advanced_billing/models/metafields.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.

Returns:



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

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/metafields.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/metafields.rb', line 24

def scope
  @scope
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

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']
  input_type = hash['input_type'] ||= MetafieldInput::TEXT
  enum = hash.key?('enum') ? hash['enum'] : SKIP

  # Create object from extracted values.
  Metafields.new(id,
                 name,
                 scope,
                 input_type,
                 enum)
end

.names ⇒ Object

A mapping from model property names to API property names.



39
40
41
42
43
44
45
46
47
 
# File 'lib/advanced_billing/models/metafields.rb', line 39

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

.nullables ⇒ Object

An array for nullable fields



61
62
63
 
# File 'lib/advanced_billing/models/metafields.rb', line 61

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



50
51
52
53
54
55
56
57
58
 
# File 'lib/advanced_billing/models/metafields.rb', line 50

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

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (Metafields | Hash) —

    value against the validation is performed.



95
96
97
98
99
100
101
 
# File 'lib/advanced_billing/models/metafields.rb', line 95

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

  return false unless value.instance_of? Hash

  true
end