Class: ShellDataReportingApIs::PricedTransactionRequestV2

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

Overview

PricedTransactionRequestV2 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(filters = SKIP, page = SKIP, page_size = SKIP) ⇒ PricedTransactionRequestV2 



49
50
51
52
53
54
55
 
# File 'lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb', line 49

def initialize(filters = SKIP,
               page = SKIP,
               page_size = SKIP)
  @filters = filters unless filters == SKIP
  @page = page unless page == SKIP
  @page_size = page_size unless page_size == SKIP
end

Instance Attribute Details

#filters ⇒ PricedRequestData

This endpoint allows querying the transaction data (i.e. Priced, Billed and Unbilled sales items) from SFSBI. It provides a flexible search criteria and supports paging



16
17
18
 
# File 'lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb', line 16

def filters
  @filters
end

#page ⇒ Integer

Specify the page of results to be returned.



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

def page
  @page
end

#page_size ⇒ Integer

Specify the number of records to returned; Max 1000



24
25
26
 
# File 'lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb', line 24

def page_size
  @page_size
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb', line 58

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  filters = PricedRequestData.from_hash(hash['Filters']) if hash['Filters']
  page = hash.key?('Page') ? hash['Page'] : SKIP
  page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP

  # Create object from extracted values.

  PricedTransactionRequestV2.new(filters,
                                 page,
                                 page_size)
end

.names ⇒ Object

A mapping from model property names to API property names.



27
28
29
30
31
32
33
 
# File 'lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb', line 27

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['filters'] = 'Filters'
  @_hash['page'] = 'Page'
  @_hash['page_size'] = 'PageSize'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



45
46
47
 
# File 'lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb', line 45

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



36
37
38
39
40
41
42
 
# File 'lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb', line 36

def self.optionals
  %w[
    filters
    page
    page_size
  ]
end