data-and-reporting-sdk 1.0.0 → 1.2.0

data/lib/shell_data_reporting_ap_is/models/logged_in_user_request.rb

@@ -72,10 +72,8 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(include_payer_group = false,
-                   include_eid_details = false,
-                   requested_api_name = SKIP,
-                   payer_id = SKIP,
+    def initialize(include_payer_group = false, include_eid_details = false,
+                   requested_api_name = SKIP, payer_id = SKIP,
                    payer_number = SKIP)
       @include_payer_group = include_payer_group unless include_payer_group == SKIP
       @include_eid_details = include_eid_details unless include_eid_details == SKIP

data/lib/shell_data_reporting_ap_is/models/logged_in_user_response.rb

@@ -71,9 +71,9 @@ module ShellDataReportingApIs
     attr_accessor :roles
 
     # List of payers which the user has access to.
-    # •	It will return 250 payers only and it is configurable. If the user has
-    # more than that, the remaining will be ignored.
-    # •	The payer which is marked as default will be the first item in the
+    # •    It will return 250 payers only and it is configurable. If the user
+    # has more than that, the remaining will be ignored.
+    # •    The payer which is marked as default will be the first item in the
     # output.
     # Note: This list will be empty for users mapped with roles which has either
     # IsShellAdmin or IsServiceAccount set to true as their access level is
@@ -225,30 +225,17 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(user_name = SKIP,
-                   display_name = SKIP,
-                   id_mssoid = SKIP,
-                   preferred_language = SKIP,
-                   is_super_admin = false,
-                   date_format = SKIP,
-                   time_format = SKIP,
-                   week_begins = SKIP,
-                   display_week = true,
-                   csv_separator = SKIP,
-                   decimal_separator = SKIP,
-                   report_format = SKIP,
-                   has_api_access = true,
-                   roles = SKIP,
-                   payers = SKIP,
-                   accounts = SKIP,
-                   collecting_companies = SKIP,
+    def initialize(user_name = SKIP, display_name = SKIP, id_mssoid = SKIP,
+                   preferred_language = SKIP, is_super_admin = false,
+                   date_format = SKIP, time_format = SKIP, week_begins = SKIP,
+                   display_week = true, csv_separator = SKIP,
+                   decimal_separator = SKIP, report_format = SKIP,
+                   has_api_access = true, roles = SKIP, payers = SKIP,
+                   accounts = SKIP, collecting_companies = SKIP,
                    eid_access_details = SKIP,
                    user_classification_by_system = SKIP,
-                   user_classification_by_shell = SKIP,
-                   payer_count = SKIP,
-                   account_count = SKIP,
-                   card_count = SKIP,
-                   error = SKIP,
+                   user_classification_by_shell = SKIP, payer_count = SKIP,
+                   account_count = SKIP, card_count = SKIP, error = SKIP,
                    request_id = SKIP)
       @user_name = user_name unless user_name == SKIP
       @display_name = display_name unless display_name == SKIP

data/lib/shell_data_reporting_ap_is/models/monthly_invoice_trend.rb

@@ -71,11 +71,8 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(currency_code = SKIP,
-                   currency_symbol = SKIP,
-                   month = SKIP,
-                   total_net_amount = SKIP,
-                   total_vat_amount = SKIP,
+    def initialize(currency_code = SKIP, currency_symbol = SKIP, month = SKIP,
+                   total_net_amount = SKIP, total_vat_amount = SKIP,
                    year = SKIP)
       @currency_code = currency_code unless currency_code == SKIP
       @currency_symbol = currency_symbol unless currency_symbol == SKIP

data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_request.rb

@@ -28,12 +28,12 @@ module ShellDataReportingApIs
 
     # List of Payers/Accounts entity.
     # Mandatory.
-    # •	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 100 and will
-    # change to 10 once SFH changes are integrated.
+    # •    This value is configurable. Initial configuration will be 100 and
+    # will change to 10 once SFH changes are integrated.
     # Note: 
-    # 1.	At least one payer should be present.
+    # 1.    At least one payer should be present.
     # Accounts information are optional.
     # @return [Array[MultiPricedTransactionRequestAccountsItems]]
     attr_accessor :accounts
@@ -72,9 +72,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
     # @return [Integer]
     attr_accessor :period
 
@@ -168,12 +168,12 @@ module ShellDataReportingApIs
     attr_accessor :include_fees
 
     # Allowed Sorting Options:
-    # 1.	TransactionDateAscending
-    # 2.	TransactionDateDescending
-    # 3.	GrossAmountDescending
-    # 4.	GrossAmountAscending
-    # 5.	NetAmountAscending
-    # 6.	NetAmountDescensding
+    # 1.    TransactionDateAscending
+    # 2.    TransactionDateDescending
+    # 3.    GrossAmountDescending
+    # 4.    GrossAmountAscending
+    # 5.    NetAmountAscending
+    # 6.    NetAmountDescensding
     # Example value to be passed: 1,3
     # Note: If IncludeFees is ‘True’ then sorting is not allowed. This parameter
     # will be ignored.
@@ -251,25 +251,14 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(col_co_code = nil,
-                   accounts = nil,
-                   col_co_id = SKIP,
-                   invoice_status = SKIP,
-                   purchased_in_country = SKIP,
-                   from_date = SKIP,
-                   to_date = SKIP,
-                   period = SKIP,
-                   posting_date_from = SKIP,
-                   posting_date_to = 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,
-                   sort_order = SKIP,
-                   current_page = SKIP,
+    def initialize(col_co_code = nil, accounts = nil, col_co_id = SKIP,
+                   invoice_status = SKIP, purchased_in_country = SKIP,
+                   from_date = SKIP, to_date = SKIP, period = SKIP,
+                   posting_date_from = SKIP, posting_date_to = 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, sort_order = SKIP, current_page = SKIP,
                    page_size = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
       @col_co_code = col_co_code

data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_request_accounts_items.rb

@@ -54,9 +54,7 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(payer_id = SKIP,
-                   payer_number = SKIP,
-                   account_id = SKIP,
+    def initialize(payer_id = SKIP, payer_number = SKIP, account_id = SKIP,
                    account_number = SKIP)
       @payer_id = payer_id unless payer_id == SKIP
       @payer_number = payer_number unless payer_number == SKIP

data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_response.rb

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

data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_response_transactions_items.rb

@@ -187,13 +187,13 @@ module ShellDataReportingApIs
 
     # Site Code
     # Example:
-    # 050001 -	CHARNOCK RICHARD NTHBOUND MWSA 0755
+    # 050001 -    CHARNOCK RICHARD NTHBOUND MWSA 0755
     # @return [String]
     attr_accessor :site_code
 
     # Site Name
     # Example:
-    # 050001 -	CHARNOCK RICHARD NTHBOUND MWSA 0755
+    # 050001 -    CHARNOCK RICHARD NTHBOUND MWSA 0755
     # @return [String]
     attr_accessor :site_name
 
@@ -216,9 +216,9 @@ module ShellDataReportingApIs
     attr_accessor :receipt_number
 
     # Product Code
-    # 10	TMF Charges
-    # 11	Tunnel/Bridges
-    # 12	Motorway toll
+    # 10    TMF Charges
+    # 11    Tunnel/Bridges
+    # 12    Motorway toll
     # @return [String]
     attr_accessor :product_code
 
@@ -233,21 +233,21 @@ module ShellDataReportingApIs
 
     # Product Group Id
     # Example: 
-    # 1	Parent Product Group
-    # 2	All Fuels
-    # 3	Motor gasoline
-    # 4	2 stroke
-    # 5	Autogas
+    # 1    Parent Product Group
+    # 2    All Fuels
+    # 3    Motor gasoline
+    # 4    2 stroke
+    # 5    Autogas
     # @return [Integer]
     attr_accessor :product_group_id
 
     # Product Group Name
     # Example: 
-    # 1	Parent Product Group
-    # 2	All Fuels
-    # 3	Motor gasoline
-    # 4	2 stroke
-    # 5	Autogas
+    # 1    Parent Product Group
+    # 2    All Fuels
+    # 3    Motor gasoline
+    # 4    2 stroke
+    # 5    Autogas
     # @return [String]
     attr_accessor :product_group_name
 
@@ -266,9 +266,9 @@ module ShellDataReportingApIs
     attr_accessor :is_shell_site
 
     # Network  (Shell PH, ESSO, etc.,)
-    # 100013	STEINDORFER
-    # 100015	S.A. BELGIAN SHELL N.V.
-    # 100016	ESSO BE
+    # 100013    STEINDORFER
+    # 100015    S.A. BELGIAN SHELL N.V.
+    # 100016    ESSO BE
     # Note: - The value could be null/blank for fees item.
     # @return [String]
     attr_accessor :network
@@ -492,13 +492,13 @@ module ShellDataReportingApIs
     attr_accessor :crm_number
 
     # Sales Item Dispute Status if disputed
-    # 0	No Dispute
-    # 1	In Dispute
-    # 2	Re-Instated
-    # 3	Adjusted
-    # 4	Written Off by Colco
-    # 5	Written Off by Delco
-    # 6	Charged Back to Site
+    # 0    No Dispute
+    # 1    In Dispute
+    # 2    Re-Instated
+    # 3    Adjusted
+    # 4    Written Off by Colco
+    # 5    Written Off by Delco
+    # 6    Charged Back to Site
     # @return [String]
     attr_accessor :dispute_status
 
@@ -1066,121 +1066,69 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(type = SKIP,
-                   card_id = SKIP,
-                   card_pan = SKIP,
-                   card_expiry = SKIP,
-                   transaction_date = SKIP,
-                   transaction_time = SKIP,
-                   utc_offset = SKIP,
-                   fleet_id_input = SKIP,
-                   odometer_input = SKIP,
-                   driver_name = SKIP,
-                   vehicle_registration = SKIP,
-                   invoice_currency_code = SKIP,
-                   invoice_currency_symbol = SKIP,
+    def initialize(type = SKIP, card_id = SKIP, card_pan = SKIP,
+                   card_expiry = SKIP, transaction_date = SKIP,
+                   transaction_time = SKIP, utc_offset = SKIP,
+                   fleet_id_input = SKIP, odometer_input = SKIP,
+                   driver_name = SKIP, vehicle_registration = SKIP,
+                   invoice_currency_code = SKIP, invoice_currency_symbol = SKIP,
                    transaction_currency_code = SKIP,
                    transaction_currency_symbol = SKIP,
-                   transaction_net_amount = SKIP,
-                   transaction_tax = SKIP,
-                   transaction_gross_amount = SKIP,
-                   invoice_net_amount = SKIP,
-                   invoice_tax = SKIP,
-                   invoice_gross_amount = SKIP,
-                   purchased_in_country = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   account_name = SKIP,
-                   account_short_name = SKIP,
-                   quantity = SKIP,
+                   transaction_net_amount = SKIP, transaction_tax = SKIP,
+                   transaction_gross_amount = SKIP, invoice_net_amount = SKIP,
+                   invoice_tax = SKIP, invoice_gross_amount = SKIP,
+                   purchased_in_country = SKIP, account_id = SKIP,
+                   account_number = SKIP, account_name = SKIP,
+                   account_short_name = SKIP, quantity = SKIP,
                    fuel_product = SKIP,
                    unit_price_in_transaction_currency = SKIP,
                    unit_price_in_invoice_currency = SKIP,
                    unit_discount_transaction_currency = SKIP,
-                   unit_discount_invoice_currency = SKIP,
-                   is_invoiced = SKIP,
-                   invoice_number = SKIP,
-                   invoice_date = SKIP,
-                   site_code = SKIP,
-                   site_name = SKIP,
-                   site_country = SKIP,
-                   location = SKIP,
-                   card_group_name = SKIP,
-                   receipt_number = SKIP,
-                   product_code = SKIP,
-                   product_name = SKIP,
-                   product_group_id = SKIP,
-                   product_group_name = SKIP,
-                   del_co_exchange_rate = SKIP,
-                   col_co_exchange_rate = SKIP,
-                   is_shell_site = SKIP,
-                   network = SKIP,
-                   site_group_id = SKIP,
-                   site_group_name = SKIP,
-                   posting_date = SKIP,
-                   issuer_code = SKIP,
-                   purchased_in_country_code = SKIP,
-                   customer_country_code = SKIP,
-                   customer_country = SKIP,
-                   release_code = SKIP,
-                   card_group_id = SKIP,
-                   card_sequence_number = SKIP,
-                   check_digit = SKIP,
-                   fleet_id_description = SKIP,
-                   vat_rate = SKIP,
-                   vat_category = SKIP,
-                   vat_country = SKIP,
+                   unit_discount_invoice_currency = SKIP, is_invoiced = SKIP,
+                   invoice_number = SKIP, invoice_date = SKIP, site_code = SKIP,
+                   site_name = SKIP, site_country = SKIP, location = SKIP,
+                   card_group_name = SKIP, receipt_number = SKIP,
+                   product_code = SKIP, product_name = SKIP,
+                   product_group_id = SKIP, product_group_name = SKIP,
+                   del_co_exchange_rate = SKIP, col_co_exchange_rate = SKIP,
+                   is_shell_site = SKIP, network = SKIP, site_group_id = SKIP,
+                   site_group_name = SKIP, posting_date = SKIP,
+                   issuer_code = SKIP, purchased_in_country_code = SKIP,
+                   customer_country_code = SKIP, customer_country = SKIP,
+                   release_code = SKIP, card_group_id = SKIP,
+                   card_sequence_number = SKIP, check_digit = SKIP,
+                   fleet_id_description = SKIP, vat_rate = SKIP,
+                   vat_category = SKIP, vat_country = SKIP,
                    effective_discount_in_trx_currency = SKIP,
-                   transaction_type = SKIP,
-                   pin_indicator = SKIP,
-                   vat_applicable = SKIP,
-                   net_invoice_indicator = SKIP,
+                   transaction_type = SKIP, pin_indicator = SKIP,
+                   vat_applicable = SKIP, net_invoice_indicator = SKIP,
                    customer_currency_code = SKIP,
                    customer_currency_symbol = SKIP,
                    effective_unit_discount_in_customer_currency = SKIP,
                    effective_discount_in_customer_currency = SKIP,
                    va_ton_net_amount_in_customer_currency = SKIP,
-                   discount_type = SKIP,
-                   transaction_status = SKIP,
-                   sales_item_id = SKIP,
-                   payer_group = SKIP,
-                   payer_group_name = SKIP,
-                   refund_flag = SKIP,
-                   original_sales_item_id = SKIP,
-                   delco_name = SKIP,
-                   delco_code = SKIP,
-                   payer_number = SKIP,
-                   payer_name = SKIP,
-                   card_expiry_period = SKIP,
-                   authorisation_code = SKIP,
-                   transaction_id = SKIP,
-                   transaction_line = SKIP,
-                   allow_clearing = SKIP,
-                   crm_number = SKIP,
-                   dispute_status = SKIP,
-                   rebate_rate = SKIP,
+                   discount_type = SKIP, transaction_status = SKIP,
+                   sales_item_id = SKIP, payer_group = SKIP,
+                   payer_group_name = SKIP, refund_flag = SKIP,
+                   original_sales_item_id = SKIP, delco_name = SKIP,
+                   delco_code = SKIP, payer_number = SKIP, payer_name = SKIP,
+                   card_expiry_period = SKIP, authorisation_code = SKIP,
+                   transaction_id = SKIP, transaction_line = SKIP,
+                   allow_clearing = SKIP, crm_number = SKIP,
+                   dispute_status = SKIP, rebate_rate = SKIP,
                    del_co_to_col_co_exchange_rate = SKIP,
-                   net_euro_amount = SKIP,
-                   euro_rebate_amount = SKIP,
-                   euro_vat_amount = SKIP,
-                   parent_customer_number = SKIP,
-                   parent_customer_name = SKIP,
-                   parent_customer_id = SKIP,
+                   net_euro_amount = SKIP, euro_rebate_amount = SKIP,
+                   euro_vat_amount = SKIP, parent_customer_number = SKIP,
+                   parent_customer_name = SKIP, parent_customer_id = SKIP,
                    incoming_site_number = SKIP,
                    incoming_site_description = SKIP,
-                   incoming_currency_code = SKIP,
-                   incoming_product_code = SKIP,
-                   credit_debit_code = SKIP,
-                   correction_flag = SKIP,
-                   additional1 = SKIP,
-                   additional2 = SKIP,
-                   additional3 = SKIP,
+                   incoming_currency_code = SKIP, incoming_product_code = SKIP,
+                   credit_debit_code = SKIP, correction_flag = SKIP,
+                   additional1 = SKIP, additional2 = SKIP, additional3 = SKIP,
                    additional4 = SKIP,
                    rebateon_net_amount_in_customer_currency = SKIP,
                    rebateon_net_amount_in_transaction_currency = SKIP,
-                   network_code = SKIP,
-                   trn_identifier = SKIP,
-                   card_type = SKIP,
+                   network_code = SKIP, trn_identifier = SKIP, card_type = SKIP,
                    delco_list_price_unit_net = SKIP,
                    delco_retail_price_unit_net = SKIP,
                    delco_retail_price_unit_gross = SKIP,

data/lib/shell_data_reporting_ap_is/models/o_auth_token.rb

@@ -62,12 +62,8 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(access_token = nil,
-                   token_type = nil,
-                   expires_in = SKIP,
-                   scope = SKIP,
-                   expiry = SKIP,
-                   refresh_token = SKIP)
+    def initialize(access_token = nil, token_type = nil, expires_in = SKIP,
+                   scope = SKIP, expiry = SKIP, refresh_token = SKIP)
       @access_token = access_token
       @token_type = token_type
       @expires_in = expires_in unless expires_in == SKIP

data/lib/shell_data_reporting_ap_is/models/past_statement_of_accounts.rb

@@ -294,38 +294,27 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(amount_due = SKIP,
-                   amount_not_overdue = SKIP,
+    def initialize(amount_due = SKIP, amount_not_overdue = SKIP,
                    amount_overdue = SKIP,
-                   amount_overdue_from_unallocated = SKIP,
-                   amount_paid = SKIP,
+                   amount_overdue_from_unallocated = SKIP, amount_paid = SKIP,
                    balance_on_this_statement = SKIP,
-                   billing_currency_code = SKIP,
-                   billing_currency_symbol = SKIP,
-                   credit_limit = SKIP,
-                   credit_limit_currency_code = SKIP,
+                   billing_currency_code = SKIP, billing_currency_symbol = SKIP,
+                   credit_limit = SKIP, credit_limit_currency_code = SKIP,
                    credit_limit_currency_symbol = SKIP,
                    credit_limit_in_customer_currency = SKIP,
-                   currency_code = SKIP,
-                   currency_symbol = SKIP,
-                   fully_paid = SKIP,
-                   last_payment_currency_code = SKIP,
+                   currency_code = SKIP, currency_symbol = SKIP,
+                   fully_paid = SKIP, last_payment_currency_code = SKIP,
                    last_payment_currency_symbol = SKIP,
-                   last_payment_date = SKIP,
-                   last_payment_value = SKIP,
-                   outstanding_balance = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   payment_due_date = SKIP,
-                   so_a_reference_number = SKIP,
-                   statement_date = SKIP,
+                   last_payment_date = SKIP, last_payment_value = SKIP,
+                   outstanding_balance = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, payment_due_date = SKIP,
+                   so_a_reference_number = SKIP, statement_date = SKIP,
                    statement_of_account_id = SKIP,
                    total_billing_documents = SKIP,
                    total_net_amount_billing_currency = SKIP,
                    total_summary_billing_documents = SKIP,
                    total_vat_amount_billing_currency = SKIP,
-                   unallocated_payment = SKIP,
-                   local_currency_code = SKIP,
+                   unallocated_payment = SKIP, local_currency_code = SKIP,
                    local_currency_symbol = SKIP,
                    local_currency_exchange_rate = SKIP)
       @amount_due = amount_due unless amount_due == SKIP

data/lib/shell_data_reporting_ap_is/models/payer_access.rb

@@ -96,14 +96,9 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(is_default = false,
-                   colco_id = SKIP,
-                   colco_code = SKIP,
-                   col_co_country_code = SKIP,
-                   payer_group_id = SKIP,
-                   payer_group = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
+    def initialize(is_default = false, colco_id = SKIP, colco_code = SKIP,
+                   col_co_country_code = SKIP, payer_group_id = SKIP,
+                   payer_group = SKIP, payer_id = SKIP, payer_number = SKIP,
                    payer_name = SKIP)
       @is_default = is_default unless is_default == SKIP
       @colco_id = colco_id unless colco_id == SKIP