data-and-reporting-sdk 1.0.0 → 1.2.0

data/lib/shell_data_reporting_ap_is/models/payer_details.rb

@@ -143,10 +143,10 @@ module ShellDataReportingApIs
     # Billing/Invoice frequency. The frequency in which the transactions will be
     # considered for invoicing in a bulling run
     # E.g.: 
-    # 1	Daily (all days)
-    # 2	Daily (only working days)
-    # 3	Weekly - Monday
-    # 4	Weekly – Tuesday
+    # 1    Daily (all days)
+    # 2    Daily (only working days)
+    # 3    Weekly - Monday
+    # 4    Weekly – Tuesday
     # Etc.
     # @return [String]
     attr_accessor :billing_frequency_type
@@ -157,10 +157,10 @@ module ShellDataReportingApIs
     attr_accessor :billing_run_frequency_type_id
 
     # Frequency at which the billing process is triggered.E.g.: 
-    # 1	Daily (all days)
-    # 2	Daily (only working days)
-    # 3	Weekly - Monday
-    # 4	Weekly – Tuesday
+    # 1    Daily (all days)
+    # 2    Daily (only working days)
+    # 3    Weekly - Monday
+    # 4    Weekly – Tuesday
     # Etc.
     # @return [String]
     attr_accessor :billing_run_frequnecy
@@ -480,13 +480,13 @@ module ShellDataReportingApIs
     # @return [String]
     attr_accessor :tolls_customer_id
 
-    # String	Colco country type id in e-TM system
+    # String    Colco country type id in e-TM system
     # This field will have value only when ReturnTollsCustomerId is set to true
     # in the request else set to null or empty.
     # @return [String]
     attr_accessor :tolls_colco_country_type_id
 
-    # String	Colco country type id in e-TM system
+    # String    Colco country type id in e-TM system
     # This field will have value only when ReturnTollsCustomerId is set to true
     # in the request else set to null or empty.
     # @return [Array[CustomerContract]]
@@ -816,111 +816,68 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(col_co_id = SKIP,
-                   col_co_code = SKIP,
-                   country_code = SKIP,
-                   country = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   payer_full_name = SKIP,
-                   payer_short_name = SKIP,
-                   payer_group_id = SKIP,
-                   amount_due = SKIP,
-                   amount_overdue = SKIP,
-                   amount_not_overdue = SKIP,
-                   outstanding_balance = SKIP,
-                   unallocated_payment = SKIP,
-                   soa_currency_code = SKIP,
-                   soa_currency_symbol = SKIP,
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, country_code = SKIP,
+                   country = SKIP, payer_id = SKIP, payer_number = SKIP,
+                   payer_full_name = SKIP, payer_short_name = SKIP,
+                   payer_group_id = SKIP, amount_due = SKIP,
+                   amount_overdue = SKIP, amount_not_overdue = SKIP,
+                   outstanding_balance = SKIP, unallocated_payment = SKIP,
+                   soa_currency_code = SKIP, soa_currency_symbol = SKIP,
                    soa_credit_limit_currency_code = SKIP,
                    soa_credit_limit_currency_symbol = SKIP,
                    last_payment_currency_code = SKIP,
                    last_payment_currency_symbol = SKIP,
-                   last_payment_amount = SKIP,
-                   last_payment_date = SKIP,
-                   soa_last_payment_amount = SKIP,
-                   soa_last_payment_date = SKIP,
-                   currency_code = SKIP,
-                   currency_symbol = SKIP,
-                   col_co_country_code = SKIP,
-                   local_currency_code = SKIP,
+                   last_payment_amount = SKIP, last_payment_date = SKIP,
+                   soa_last_payment_amount = SKIP, soa_last_payment_date = SKIP,
+                   currency_code = SKIP, currency_symbol = SKIP,
+                   col_co_country_code = SKIP, local_currency_code = SKIP,
                    local_currency_symbol = SKIP,
                    local_currency_exchange_rate = SKIP,
                    local_currency_exchange_rate_so_a = SKIP,
                    billing_frequency_type_id = SKIP,
                    billing_frequency_type = SKIP,
                    billing_run_frequency_type_id = SKIP,
-                   billing_run_frequnecy = SKIP,
-                   day1_run = SKIP,
-                   day2_run = SKIP,
-                   day3_run = SKIP,
-                   day4_run = SKIP,
-                   invoice_distribution_methods = SKIP,
-                   output_type = SKIP,
-                   invoice_account_id = SKIP,
-                   invoice_account_number = SKIP,
-                   invoice_account_short_name = SKIP,
-                   best_of_indicator = false,
-                   is_international = false,
-                   total_accounts = SKIP,
-                   total_active_accounts = SKIP,
-                   total_cards = SKIP,
-                   total_active_cards = SKIP,
-                   total_blocked_cards = SKIP,
-                   total_cancelled_cards = SKIP,
-                   total_expired_cards = SKIP,
+                   billing_run_frequnecy = SKIP, day1_run = SKIP,
+                   day2_run = SKIP, day3_run = SKIP, day4_run = SKIP,
+                   invoice_distribution_methods = SKIP, output_type = SKIP,
+                   invoice_account_id = SKIP, invoice_account_number = SKIP,
+                   invoice_account_short_name = SKIP, best_of_indicator = false,
+                   is_international = false, total_accounts = SKIP,
+                   total_active_accounts = SKIP, total_cards = SKIP,
+                   total_active_cards = SKIP, total_blocked_cards = SKIP,
+                   total_cancelled_cards = SKIP, total_expired_cards = SKIP,
                    total_renewal_pending_cards = SKIP,
                    total_replaced_cards = SKIP,
                    total_temporary_block_cards_by_customer = SKIP,
                    total_temporary_block_cards_by_shell = SKIP,
-                   total_new_cards = SKIP,
-                   total_fraud_cards = SKIP,
+                   total_new_cards = SKIP, total_fraud_cards = SKIP,
                    total_blocked_accounts = SKIP,
-                   total_cancelled_accounts = SKIP,
-                   payer_trading_name = SKIP,
-                   status = SKIP,
-                   billing_language = SKIP,
-                   legal_entity = SKIP,
-                   date_established = SKIP,
-                   customer_classification = SKIP,
-                   industry_class = SKIP,
-                   marketing_segmentation = SKIP,
-                   line_of_business = SKIP,
-                   print_credit_limit = false,
-                   card_group_type = SKIP,
-                   renew_cards = false,
-                   allow_select_pin = false,
-                   use_fleet_pin = SKIP,
-                   vat_reg_number = SKIP,
-                   vat_reg_number2 = SKIP,
-                   registration_number = SKIP,
-                   registration_number2 = SKIP,
-                   sales_ledger_balance = SKIP,
-                   exposure = SKIP,
-                   outstanding_debt = SKIP,
-                   available_credit = SKIP,
-                   band = SKIP,
-                   global_customer_reference_id = SKIP,
+                   total_cancelled_accounts = SKIP, payer_trading_name = SKIP,
+                   status = SKIP, billing_language = SKIP, legal_entity = SKIP,
+                   date_established = SKIP, customer_classification = SKIP,
+                   industry_class = SKIP, marketing_segmentation = SKIP,
+                   line_of_business = SKIP, print_credit_limit = false,
+                   card_group_type = SKIP, renew_cards = false,
+                   allow_select_pin = false, use_fleet_pin = SKIP,
+                   vat_reg_number = SKIP, vat_reg_number2 = SKIP,
+                   registration_number = SKIP, registration_number2 = SKIP,
+                   sales_ledger_balance = SKIP, exposure = SKIP,
+                   outstanding_debt = SKIP, available_credit = SKIP,
+                   band = SKIP, global_customer_reference_id = SKIP,
                    credit_limit = SKIP,
                    credit_limit_in_customer_currency = SKIP,
-                   billing_currency_code = SKIP,
-                   billing_currency_symbol = SKIP,
-                   payment_method = SKIP,
-                   payment_terms = SKIP,
+                   billing_currency_code = SKIP, billing_currency_symbol = SKIP,
+                   payment_method = SKIP, payment_terms = SKIP,
                    temporary_credit_limit_increase = SKIP,
                    temporary_credit_limit_increase_in_customer_currency = SKIP,
                    temporary_credit_limit_expiry_date = SKIP,
-                   payer_bank_account = SKIP,
-                   card_delivery_address = SKIP,
-                   correspondance_address = SKIP,
-                   billing_address = SKIP,
+                   payer_bank_account = SKIP, card_delivery_address = SKIP,
+                   correspondance_address = SKIP, billing_address = SKIP,
                    has_active_vol_based_pricing = SKIP,
                    has_active_vol_based_bonus = SKIP,
                    has_active_vol_based_association_bonus = SKIP,
-                   finance_currency = SKIP,
-                   tolls_customer_id = SKIP,
-                   tolls_colco_country_type_id = SKIP,
-                   contracts = SKIP)
+                   finance_currency = SKIP, tolls_customer_id = SKIP,
+                   tolls_colco_country_type_id = SKIP, contracts = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
       @col_co_code = col_co_code unless col_co_code == SKIP
       @country_code = country_code unless country_code == SKIP

data/lib/shell_data_reporting_ap_is/models/payer_request.rb

@@ -12,10 +12,10 @@ module ShellDataReportingApIs
     # List of Payer entity.
     # Optional.
     # Note:
-    # •	Max number of payers allowed in the input is 10, if it exceeds in the
+    # •    Max number of payers allowed in the input is 10, if it exceeds in the
     # input it will throw an error.
-    # •	This value is configurable. Initial configuration will be 1000 and will
-    # change to 10 once SFH changes are integrated.
+    # •    This value is configurable. Initial configuration will be 1000 and
+    # will change to 10 once SFH changes are integrated.
     # @return [Array[Payers]]
     attr_accessor :payers
 
@@ -41,9 +41,9 @@ module ShellDataReportingApIs
     # Default value 50
     # Return 250 rows only in the response if -1 is supplied as page size.
     # Note: 
-    # •	Max page size is 250, if the user provided value is more than 250 then
-    # it will throw error.
-    # •	This value is configurable.
+    # •    Max page size is 250, if the user provided value is more than 250
+    # then it will throw error.
+    # •    This value is configurable.
     # @return [Integer]
     attr_accessor :page_size
 
@@ -76,12 +76,9 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(payers = SKIP,
-                   return_basic_details_only = false,
-                   include_addresses = false,
-                   include_bonus_parameters = false,
-                   current_page = SKIP,
-                   page_size = SKIP)
+    def initialize(payers = SKIP, return_basic_details_only = false,
+                   include_addresses = false, include_bonus_parameters = false,
+                   current_page = SKIP, page_size = SKIP)
       @payers = payers unless payers == SKIP
       unless return_basic_details_only == SKIP
         @return_basic_details_only =

data/lib/shell_data_reporting_ap_is/models/payer_response.rb

@@ -68,12 +68,8 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(request_id = SKIP,
-                   payers = SKIP,
-                   current_page = SKIP,
-                   row_count = SKIP,
-                   total_pages = SKIP,
-                   error = SKIP)
+    def initialize(request_id = SKIP, payers = SKIP, current_page = SKIP,
+                   row_count = SKIP, total_pages = SKIP, error = SKIP)
       @request_id = request_id unless request_id == SKIP
       @payers = payers unless payers == SKIP
       @current_page = current_page unless current_page == SKIP

data/lib/shell_data_reporting_ap_is/models/payers.rb

@@ -71,11 +71,8 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(col_co_id = SKIP,
-                   col_co_code = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   payer_name = SKIP,
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, payer_name = SKIP,
                    payer_group_id = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
       @col_co_code = col_co_code unless col_co_code == SKIP

data/lib/shell_data_reporting_ap_is/models/payments_since_last_soa.rb

@@ -194,26 +194,17 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(account_id = SKIP,
-                   account_number = SKIP,
-                   account_short_name = SKIP,
-                   summary_document_id = SKIP,
-                   summary_document_number = SKIP,
-                   summary_document_date = SKIP,
+    def initialize(account_id = SKIP, account_number = SKIP,
+                   account_short_name = SKIP, summary_document_id = SKIP,
+                   summary_document_number = SKIP, summary_document_date = SKIP,
                    summary_document_payment_due_date = SKIP,
                    summary_document_total_value = SKIP,
                    summary_document_total_vat = SKIP,
-                   summary_document_dd_amount = SKIP,
-                   payment_date = SKIP,
-                   payment_reference = SKIP,
-                   payment_currency_code = SKIP,
-                   payment_currency_symbol = SKIP,
-                   amount_paid = SKIP,
-                   balance = SKIP,
-                   true_payment = SKIP,
-                   prepaid_balance = SKIP,
-                   local_currency_code = SKIP,
-                   local_currency_symbol = SKIP,
+                   summary_document_dd_amount = SKIP, payment_date = SKIP,
+                   payment_reference = SKIP, payment_currency_code = SKIP,
+                   payment_currency_symbol = SKIP, amount_paid = SKIP,
+                   balance = SKIP, true_payment = SKIP, prepaid_balance = SKIP,
+                   local_currency_code = SKIP, local_currency_symbol = SKIP,
                    local_currency_exchange_rate = SKIP)
       @account_id = account_id unless account_id == SKIP
       @account_number = account_number unless account_number == SKIP

data/lib/shell_data_reporting_ap_is/models/pin_advice_types.rb

@@ -11,10 +11,10 @@ module ShellDataReportingApIs
 
     # Id of of PIN advice type.
     # Possible Values:
-    # 1.	Paper
-    # 2.	Email
-    # 3.	SMS
-    # 4.	None
+    # 1.    Paper
+    # 2.    Email
+    # 3.    SMS
+    # 4.    None
     # @return [Integer]
     attr_accessor :pin_advice_type_id
 
@@ -51,8 +51,7 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(pin_advice_type_id = SKIP,
-                   is_card_order_option = SKIP,
+    def initialize(pin_advice_type_id = SKIP, is_card_order_option = SKIP,
                    is_pin_reminder_option = SKIP)
       @pin_advice_type_id = pin_advice_type_id unless pin_advice_type_id == SKIP
       @is_card_order_option = is_card_order_option unless is_card_order_option == SKIP

data/lib/shell_data_reporting_ap_is/models/price_list.rb

@@ -92,12 +92,12 @@ module ShellDataReportingApIs
 
     # Price Type
     # Possible Values are:
-    # •	Country– Price rule defined at country whereas Price Rule DelcoId same
-    # as ColcoId.
-    # •	TPNDelcoPrice – Price rule defined in the TPN whereas Price Rule DelcoId
-    # is different from ColcoId.
-    # •	NetworkPrice – Price rule defined at Fuel Network level.
-    # •	Other – Price rule defined at either Site or SiteGroup level.
+    # •    Country– Price rule defined at country whereas Price Rule DelcoId
+    # same as ColcoId.
+    # •    TPNDelcoPrice – Price rule defined in the TPN whereas Price Rule
+    # DelcoId is different from ColcoId.
+    # •    NetworkPrice – Price rule defined at Fuel Network level.
+    # •    Other – Price rule defined at either Site or SiteGroup level.
     # @return [String]
     attr_accessor :price_type
 
@@ -136,9 +136,9 @@ module ShellDataReportingApIs
 
     # Company Name of the price rule DelCo. 
     # E.g.: 
-    # •	Pilipinas Shell Petroleum Corp
-    # •	Shell U.K. Oil Products Limited
-    # •	G & V SERVICE STATIONS NV
+    # •    Pilipinas Shell Petroleum Corp
+    # •    Shell U.K. Oil Products Limited
+    # •    G & V SERVICE STATIONS NV
     # @return [String]
     attr_accessor :price_rule_delco_name
 
@@ -301,42 +301,22 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(date = SKIP,
-                   day = SKIP,
-                   type = SKIP,
-                   price_list_id = SKIP,
-                   price_list_description = SKIP,
-                   price_rule_id = SKIP,
-                   price_rule_name = SKIP,
-                   del_co_id = SKIP,
-                   country_code = SKIP,
-                   country = SKIP,
-                   product_group_id = SKIP,
-                   product_group_name = SKIP,
-                   product_code = SKIP,
-                   product_id = SKIP,
-                   product_name = SKIP,
-                   price_per_unit = SKIP,
-                   currency_code = SKIP,
-                   currency_symbol = SKIP,
-                   price_type = SKIP,
-                   site_group_id = SKIP,
-                   site_group_name = SKIP,
-                   site_code = SKIP,
-                   site_id = SKIP,
-                   site_name = SKIP,
-                   fuel_network_id = SKIP,
-                   network_name = SKIP,
-                   price_rule_delco_id = SKIP,
-                   price_rule_delco_name = SKIP,
-                   price_rule_country = SKIP,
-                   price_rule_country_code = SKIP,
-                   price_rule_basis_id = SKIP,
-                   discount_value = SKIP,
-                   price_per_unit_after_discount = SKIP,
-                   vat_percentage = SKIP,
-                   price_rule_category_id = SKIP,
-                   tiers = SKIP)
+    def initialize(date = SKIP, day = SKIP, type = SKIP, price_list_id = SKIP,
+                   price_list_description = SKIP, price_rule_id = SKIP,
+                   price_rule_name = SKIP, del_co_id = SKIP,
+                   country_code = SKIP, country = SKIP, product_group_id = SKIP,
+                   product_group_name = SKIP, product_code = SKIP,
+                   product_id = SKIP, product_name = SKIP,
+                   price_per_unit = SKIP, currency_code = SKIP,
+                   currency_symbol = SKIP, price_type = SKIP,
+                   site_group_id = SKIP, site_group_name = SKIP,
+                   site_code = SKIP, site_id = SKIP, site_name = SKIP,
+                   fuel_network_id = SKIP, network_name = SKIP,
+                   price_rule_delco_id = SKIP, price_rule_delco_name = SKIP,
+                   price_rule_country = SKIP, price_rule_country_code = SKIP,
+                   price_rule_basis_id = SKIP, discount_value = SKIP,
+                   price_per_unit_after_discount = SKIP, vat_percentage = SKIP,
+                   price_rule_category_id = SKIP, tiers = SKIP)
       @date = date unless date == SKIP
       @day = day unless day == SKIP
       @type = type unless type == SKIP

data/lib/shell_data_reporting_ap_is/models/price_trans_summary_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
 
@@ -133,9 +133,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.
@@ -144,10 +144,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
@@ -333,35 +333,19 @@ 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,
-                   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,
+    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,
+                   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)
       @col_co_id = col_co_id unless col_co_id == SKIP
       @col_co_code = col_co_code unless col_co_code == SKIP