Class: ShellCardManagementApIs::SearchProductRestriction

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

Overview

SearchProductRestriction 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(products = SKIP, product_groups = SKIP) ⇒ SearchProductRestriction

Returns a new instance of SearchProductRestriction.



41
42
43
44
 
# File 'lib/shell_card_management_ap_is/models/search_product_restriction.rb', line 41

def initialize(products = SKIP, product_groups = SKIP)
  @products = products unless products == SKIP
  @product_groups = product_groups unless product_groups == SKIP
end

Instance Attribute Details

#product_groups ⇒ Array[ProductGroup]

TODO: Write general description for this method

Returns:



18
19
20
 
# File 'lib/shell_card_management_ap_is/models/search_product_restriction.rb', line 18

def product_groups
  @product_groups
end

#products ⇒ Array[RestrictionProduct]

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/shell_card_management_ap_is/models/search_product_restriction.rb', line 14

def products
  @products
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/shell_card_management_ap_is/models/search_product_restriction.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  products = nil
  unless hash['Products'].nil?
    products = []
    hash['Products'].each do |structure|
      products << (RestrictionProduct.from_hash(structure) if structure)
    end
  end

  products = SKIP unless hash.key?('Products')
  # Parameter is an array, so we need to iterate through it
  product_groups = nil
  unless hash['ProductGroups'].nil?
    product_groups = []
    hash['ProductGroups'].each do |structure|
      product_groups << (ProductGroup.from_hash(structure) if structure)
    end
  end

  product_groups = SKIP unless hash.key?('ProductGroups')

  # Create object from extracted values.
  SearchProductRestriction.new(products,
                               product_groups)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/shell_card_management_ap_is/models/search_product_restriction.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['products'] = 'Products'
  @_hash['product_groups'] = 'ProductGroups'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/shell_card_management_ap_is/models/search_product_restriction.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/shell_card_management_ap_is/models/search_product_restriction.rb', line 29

def self.optionals
  %w[
    products
    product_groups
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



84
85
86
87
88
 
# File 'lib/shell_card_management_ap_is/models/search_product_restriction.rb', line 84

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



78
79
80
81
 
# File 'lib/shell_card_management_ap_is/models/search_product_restriction.rb', line 78

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