Class: ShellDataReportingApIs::ExceptionProduct

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_data_reporting_ap_is/models/exception_product.rb

Overview

ExceptionProduct 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(productid = SKIP, product_code = SKIP) ⇒ ExceptionProduct

Returns a new instance of ExceptionProduct.



46
47
48
49
 
# File 'lib/shell_data_reporting_ap_is/models/exception_product.rb', line 46

def initialize(productid = SKIP, product_code = SKIP)
  @productid = productid unless productid == SKIP
  @product_code = product_code unless product_code == SKIP
end

Instance Attribute Details

#product_code ⇒ String

Product Code Optional if ProductId is passed else Mandatory.

Returns:

  • (String) 


20
21
22
 
# File 'lib/shell_data_reporting_ap_is/models/exception_product.rb', line 20

def product_code
  @product_code
end

#productid ⇒ Integer

Product Id Optional if ProductCode is passed else Mandatory.

Returns:

  • (Integer) 


15
16
17
 
# File 'lib/shell_data_reporting_ap_is/models/exception_product.rb', line 15

def productid
  @productid
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/shell_data_reporting_ap_is/models/exception_product.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  productid = hash.key?('Productid') ? hash['Productid'] : SKIP
  product_code = hash.key?('ProductCode') ? hash['ProductCode'] : SKIP

  # Create object from extracted values.
  ExceptionProduct.new(productid,
                       product_code)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['productid'] = 'Productid'
  @_hash['product_code'] = 'ProductCode'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
42
43
44
 
# File 'lib/shell_data_reporting_ap_is/models/exception_product.rb', line 39

def self.nullables
  %w[
    productid
    product_code
  ]
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    productid
    product_code
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



71
72
73
74
 
# File 'lib/shell_data_reporting_ap_is/models/exception_product.rb', line 71

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



65
66
67
68
 
# File 'lib/shell_data_reporting_ap_is/models/exception_product.rb', line 65

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