Class: ShellCardManagementApIs::RestrictionProduct

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_card_management_ap_is/models/restriction_product.rb

Overview

RestrictionProduct 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(global_product_code = SKIP, description = SKIP) ⇒ RestrictionProduct

Returns a new instance of RestrictionProduct.



43
44
45
46
 
# File 'lib/shell_card_management_ap_is/models/restriction_product.rb', line 43

def initialize(global_product_code = SKIP, description = SKIP)
  @global_product_code = global_product_code unless global_product_code == SKIP
  @description = description unless description == SKIP
end

Instance Attribute Details

#description ⇒ String

The description returned by the Gateway API. Example: High Performance Diesel

Returns:

  • (String) 


20
21
22
 
# File 'lib/shell_card_management_ap_is/models/restriction_product.rb', line 20

def description
  @description
end

#global_product_code ⇒ String

The productCode returned by the Gateway API. Example: 021

Returns:

  • (String) 


15
16
17
 
# File 'lib/shell_card_management_ap_is/models/restriction_product.rb', line 15

def global_product_code
  @global_product_code
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/shell_card_management_ap_is/models/restriction_product.rb', line 49

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  global_product_code =
    hash.key?('GlobalProductCode') ? hash['GlobalProductCode'] : SKIP
  description = hash.key?('Description') ? hash['Description'] : SKIP

  # Create object from extracted values.

  RestrictionProduct.new(global_product_code,
                         description)
end

.names ⇒ Object

A mapping from model property names to API property names.



23
24
25
26
27
28
 
# File 'lib/shell_card_management_ap_is/models/restriction_product.rb', line 23

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['global_product_code'] = 'GlobalProductCode'
  @_hash['description'] = 'Description'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/shell_card_management_ap_is/models/restriction_product.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



31
32
33
34
35
36
 
# File 'lib/shell_card_management_ap_is/models/restriction_product.rb', line 31

def self.optionals
  %w[
    global_product_code
    description
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



70
71
72
73
74
 
# File 'lib/shell_card_management_ap_is/models/restriction_product.rb', line 70

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



63
64
65
66
67
 
# File 'lib/shell_card_management_ap_is/models/restriction_product.rb', line 63

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