data-and-reporting-sdk 1.0.0 → 1.1.0

data/lib/shell_data_reporting_ap_is/models/price_transaction_request.rb

@@ -84,10 +84,10 @@ module ShellDataReportingApIs
 
     # Product Id
     # Example: 
-    # 21	Unleaded - High octane
-    # 22	Unleaded - Medium octane
-    # 23	Unleaded - Low octane
-    # 24	Unleaded Environmental
+    # 21    Unleaded - High octane
+    # 22    Unleaded - Medium octane
+    # 23    Unleaded - Low octane
+    # 24    Unleaded Environmental
     # @return [Integer]
     attr_accessor :product_id
 
@@ -95,10 +95,10 @@ module ShellDataReportingApIs
     # Optional
     # Max Length: 8
     # Example: 
-    # 10	TMF Charges
-    # 11	Tunnel/Bridges
-    # 12	Motorway toll
-    # 13	Ferries
+    # 10    TMF Charges
+    # 11    Tunnel/Bridges
+    # 12    Motorway toll
+    # 13    Ferries
     # @return [String]
     attr_accessor :product_code
 
@@ -112,19 +112,20 @@ module ShellDataReportingApIs
     attr_accessor :card_group_id
 
     # Allowed Sorting Options:
-    # 1.	TransactionDateAscending
-    # 2.	TransactionDateDescending
-    # 3.	GrossAmountDescending
-    # 4.	GrossAmountAscending
-    # 5.	DriverNameAscending (If Driver Name is null then VRN value will be
+    # 1.    TransactionDateAscending
+    # 2.    TransactionDateDescending
+    # 3.    GrossAmountDescending
+    # 4.    GrossAmountAscending
+    # 5.    DriverNameAscending (If Driver Name is null then VRN value will be
     # considered)
-    # 6.	DriverNameDescending (If Driver Name is null then VRN value will be
+    # 6.    DriverNameDescending (If Driver Name is null then VRN value will be
     # considered)
-    # 7.	VRNAscending (If VRN is null then Driver Name value will be considered)
-    # 8.	VRNDescending (If VRN is null then Driver Name value will be
+    # 7.    VRNAscending (If VRN is null then Driver Name value will be
     # considered)
-    # 9.	NetAmountAscending
-    # 10.	NetAmountDescensding
+    # 8.    VRNDescending (If VRN is null then Driver Name value will be
+    # considered)
+    # 9.    NetAmountAscending
+    # 10.    NetAmountDescensding
     # Example value to be passed: “1,3”
     # @return [String]
     attr_accessor :sort_order
@@ -151,9 +152,9 @@ module ShellDataReportingApIs
 
     # Transactions Period. 
     # Possible values are:
-    # 1.	Last 7 Days
-    # 2.	Last 30 Days
-    # 3.	Last 90 Days
+    # 1.    Last 7 Days
+    # 2.    Last 30 Days
+    # 3.    Last 90 Days
     # Optional - Refer introduction section of this operation for the priority
     # and sequence of different date and invoice number filters that are
     # conditionally applied.
@@ -162,10 +163,10 @@ module ShellDataReportingApIs
 
     # Site Code as configured in GFN
     # Example:
-    # 050001 -	CHARNOCK RICHARD NTHBOUND MWSA 0755
-    # 050002 -	CHARNOCK RICHARD STHBOUND MWSA 0755
-    # 050005 -	HARTSHEAD MOOR EASTBOUND MWSA 0761.
-    # 050006 -	HARTSHEAD MOOR WESTBOUND MWSA.
+    # 050001 -    CHARNOCK RICHARD NTHBOUND MWSA 0755
+    # 050002 -    CHARNOCK RICHARD STHBOUND MWSA 0755
+    # 050005 -    HARTSHEAD MOOR EASTBOUND MWSA 0761.
+    # 050006 -    HARTSHEAD MOOR WESTBOUND MWSA.
     # Note: If IncludeFees is true then this filter will be ignored
     # @return [String]
     attr_accessor :site_code
@@ -412,40 +413,21 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(col_co_id = SKIP,
-                   col_co_code = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   accounts = SKIP,
-                   card_id = SKIP,
-                   card_pan = SKIP,
-                   driver_name = SKIP,
-                   vehicle_registration_number = SKIP,
-                   invoice_status = SKIP,
-                   product_id = SKIP,
-                   product_code = SKIP,
-                   purchased_in_country = SKIP,
-                   card_group_id = SKIP,
-                   sort_order = SKIP,
-                   from_date = SKIP,
-                   to_date = SKIP,
-                   period = SKIP,
-                   site_code = SKIP,
-                   site_group_id = SKIP,
-                   posting_date_from = SKIP,
-                   posting_date_to = SKIP,
-                   sales_item_id = SKIP,
-                   transaction_id = SKIP,
-                   invoice_date = SKIP,
-                   invoice_number = SKIP,
-                   valid_invoice_date_only = SKIP,
-                   invoice_from_date = SKIP,
-                   invoice_to_date = SKIP,
-                   fuel_only = SKIP,
-                   include_fees = SKIP,
-                   use_field_id = SKIP,
-                   current_page = SKIP,
-                   page_size = SKIP)
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, accounts = SKIP, card_id = SKIP,
+                   card_pan = SKIP, driver_name = SKIP,
+                   vehicle_registration_number = SKIP, invoice_status = SKIP,
+                   product_id = SKIP, product_code = SKIP,
+                   purchased_in_country = SKIP, card_group_id = SKIP,
+                   sort_order = SKIP, from_date = SKIP, to_date = SKIP,
+                   period = SKIP, site_code = SKIP, site_group_id = SKIP,
+                   posting_date_from = SKIP, posting_date_to = SKIP,
+                   sales_item_id = SKIP, transaction_id = SKIP,
+                   invoice_date = SKIP, invoice_number = SKIP,
+                   valid_invoice_date_only = SKIP, invoice_from_date = SKIP,
+                   invoice_to_date = SKIP, fuel_only = SKIP,
+                   include_fees = SKIP, use_field_id = SKIP,
+                   current_page = SKIP, page_size = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
       @col_co_code = col_co_code unless col_co_code == SKIP
       @payer_id = payer_id unless payer_id == SKIP

data/lib/shell_data_reporting_ap_is/models/priced_request_data.rb

@@ -15,9 +15,8 @@ module ShellDataReportingApIs
     # @return [String]
     attr_accessor :col_co_code
 
-    # Invoice status of the transactions. Mandatory Possible options:I -
-    # Invoiced, U – Un-Invoiced, A – All
-    # @return [PricedTransactionReqV2InvoiceStatusEnum]
+    # Collecting Company Code (Shell Code) of the selected payer.
+    # @return [Object]
     attr_accessor :invoice_status
 
     # Payer Number of the selected payer.
@@ -98,13 +97,9 @@ module ShellDataReportingApIs
     # @return [Array[Integer]]
     attr_accessor :cards
 
-    # Allowed Sorting Options
-    # 1.    TransactionDateAscending
-    # 2.    TransactionDateDescending
-    # 3.    GrossAmountDescending
-    # 4.    GrossAmountAscending
-    # 5.    NetAmountAscending
-    # 6.    NetAmountDescensding
+    # This entity accepts the list of CardId to filter in the response.
+    # Note: The number of cardId allowed to be passed in the request is
+    # configurable to a maximum of 500 cards.
     # @return [PricedTransactionReqV2SortOrderEnum]
     attr_accessor :sort_order
 
@@ -116,10 +111,7 @@ module ShellDataReportingApIs
     # @return [String]
     attr_accessor :to_date
 
-    # Pass below one of the value as per the required transaction period
-    # 1. Last 7 Days
-    # 2. Last 30 Days
-    # 3. Last 90 Days
+    # To transaction delivery date
     # @return [PricedTransactionReqV2PeriodEnum]
     attr_accessor :period
 
@@ -269,7 +261,6 @@ module ShellDataReportingApIs
     def self.nullables
       %w[
         col_co_code
-        invoice_status
         payer_number
         account_id
         account_number
@@ -303,42 +294,22 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(col_co_code = nil,
-                   invoice_status = nil,
-                   payer_number = nil,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   driver_name = SKIP,
-                   card_group_id = SKIP,
-                   card_pan = SKIP,
-                   product_code = SKIP,
-                   product_name = SKIP,
-                   site_code = SKIP,
-                   incoming_site_number = SKIP,
-                   invoice_date = SKIP,
-                   invoice_number = SKIP,
-                   purchased_in_country_code = SKIP,
-                   purchased_in_country = SKIP,
-                   site_group_id = SKIP,
-                   vehicle_registration_number = SKIP,
-                   fee_type_id = SKIP,
-                   line_item_description = SKIP,
-                   cards = SKIP,
-                   sort_order = SKIP,
-                   from_date = SKIP,
-                   to_date = SKIP,
-                   period = SKIP,
-                   posting_date_from = SKIP,
-                   posting_date_to = SKIP,
-                   transaction_item_id = SKIP,
-                   fuel_only = false,
-                   include_fees = SKIP,
-                   is_multipayer = SKIP,
-                   valid_invoice_date_only = false,
-                   invoice_from_date = SKIP,
+    def initialize(col_co_code = nil, invoice_status = nil, payer_number = nil,
+                   account_id = SKIP, account_number = SKIP, driver_name = SKIP,
+                   card_group_id = SKIP, card_pan = SKIP, product_code = SKIP,
+                   product_name = SKIP, site_code = SKIP,
+                   incoming_site_number = SKIP, invoice_date = SKIP,
+                   invoice_number = SKIP, purchased_in_country_code = SKIP,
+                   purchased_in_country = SKIP, site_group_id = SKIP,
+                   vehicle_registration_number = SKIP, fee_type_id = SKIP,
+                   line_item_description = SKIP, cards = SKIP,
+                   sort_order = SKIP, from_date = SKIP, to_date = SKIP,
+                   period = SKIP, posting_date_from = SKIP,
+                   posting_date_to = SKIP, transaction_item_id = SKIP,
+                   fuel_only = false, include_fees = SKIP, is_multipayer = SKIP,
+                   valid_invoice_date_only = false, invoice_from_date = SKIP,
                    invoice_to_date = SKIP,
-                   hosting_collecting_company_number = SKIP,
-                   search = SKIP,
+                   hosting_collecting_company_number = SKIP, search = SKIP,
                    transaction_id = SKIP)
       @col_co_code = col_co_code
       @invoice_status = invoice_status