data-and-reporting-sdk 1.3.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +66 -35
- data/lib/shell_data_reporting_ap_is/api_helper.rb +2 -2
- data/lib/shell_data_reporting_ap_is/client.rb +11 -12
- data/lib/shell_data_reporting_ap_is/configuration.rb +23 -25
- data/lib/shell_data_reporting_ap_is/controllers/base_controller.rb +3 -9
- data/lib/shell_data_reporting_ap_is/controllers/customer_controller.rb +251 -288
- data/lib/shell_data_reporting_ap_is/controllers/invoice_controller.rb +20 -20
- data/lib/shell_data_reporting_ap_is/controllers/o_auth_authorization_controller.rb +7 -7
- data/lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb +204 -259
- data/lib/shell_data_reporting_ap_is/exceptions/api_exception.rb +2 -2
- data/lib/shell_data_reporting_ap_is/exceptions/error_object_exception.rb +7 -5
- data/lib/shell_data_reporting_ap_is/exceptions/o_auth_provider_exception.rb +7 -5
- data/lib/shell_data_reporting_ap_is/http/auth/{bearer_token.rb → o_auth2.rb} +28 -27
- data/lib/shell_data_reporting_ap_is/http/http_call_back.rb +2 -2
- data/lib/shell_data_reporting_ap_is/http/http_method_enum.rb +2 -2
- data/lib/shell_data_reporting_ap_is/http/http_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/http/http_response.rb +2 -2
- data/lib/shell_data_reporting_ap_is/http/proxy_settings.rb +13 -0
- data/lib/shell_data_reporting_ap_is/models/account_access.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/account_req.rb +84 -0
- data/lib/shell_data_reporting_ap_is/models/account_request.rb +3 -3
- data/lib/shell_data_reporting_ap_is/models/account_res.rb +158 -0
- data/lib/shell_data_reporting_ap_is/models/account_response_accounts_items.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/accounts.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/address.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/associated_account.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/audit_array_elements.rb +71 -0
- data/lib/shell_data_reporting_ap_is/models/audit_req.rb +84 -0
- data/lib/shell_data_reporting_ap_is/models/audit_request.rb +29 -41
- data/lib/shell_data_reporting_ap_is/models/audit_response.rb +88 -53
- data/lib/shell_data_reporting_ap_is/models/audit_response_audits_items.rb +29 -6
- data/lib/shell_data_reporting_ap_is/models/bank_account.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/base_model.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/bonus_configuration.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/bonus_history.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/card_day_time_restrictions.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/card_exceptions.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/card_group_req.rb +84 -0
- data/lib/shell_data_reporting_ap_is/models/card_group_request.rb +6 -31
- data/lib/shell_data_reporting_ap_is/models/card_group_res.rb +158 -0
- data/lib/shell_data_reporting_ap_is/models/card_group_response_card_groups_items.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/{error_user_access.rb → card_type_req.rb} +14 -14
- data/lib/shell_data_reporting_ap_is/models/card_type_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/card_type_res.rb +91 -0
- data/lib/shell_data_reporting_ap_is/models/card_type_response_customer_card_types_items.rb +3 -3
- data/lib/shell_data_reporting_ap_is/models/card_usage_restrictions.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/card_usage_summary_req.rb +62 -0
- data/lib/shell_data_reporting_ap_is/models/card_usage_summary_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/card_usage_summary_res.rb +116 -0
- data/lib/shell_data_reporting_ap_is/models/card_usage_summary_response.rb +6 -26
- data/lib/shell_data_reporting_ap_is/models/col_co_access.rb +4 -4
- data/lib/shell_data_reporting_ap_is/models/current_volume.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/customer_contract.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/customer_detail_request.rb +4 -4
- data/lib/shell_data_reporting_ap_is/models/customer_detail_response.rb +5 -32
- data/lib/shell_data_reporting_ap_is/models/customer_price_list_req.rb +62 -0
- data/lib/shell_data_reporting_ap_is/models/customer_price_list_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/customer_price_list_res.rb +91 -0
- data/lib/shell_data_reporting_ap_is/models/customer_price_list_response.rb +7 -29
- data/lib/shell_data_reporting_ap_is/models/{default_error_fault_detail.rb → customer_req.rb} +15 -15
- data/lib/shell_data_reporting_ap_is/models/customer_res.rb +91 -0
- data/lib/shell_data_reporting_ap_is/models/delivery_addresses.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/eid_access.rb +3 -3
- data/lib/shell_data_reporting_ap_is/models/eid_document.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/eid_document_response.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/eid_download_req.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/eid_download_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/eid_search_req.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/eid_search_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/error_details.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/exception_product.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/exception_site_location.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fee_item.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fee_rule_location.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fee_rule_product.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fee_rule_tier.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fee_summary_response.rb +57 -38
- data/lib/shell_data_reporting_ap_is/models/fees_fee_rule_tiers.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/filters.rb +522 -0
- data/lib/shell_data_reporting_ap_is/models/{finance_currency.rb → finance_currency2.rb} +8 -9
- data/lib/shell_data_reporting_ap_is/models/fleetmanagement_v1_user_loggedinuser_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fuel_consumption_card.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fuel_consumption_data.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fuel_consumption_req.rb +62 -0
- data/lib/shell_data_reporting_ap_is/models/fuel_consumption_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/fuel_consumption_response.rb +58 -33
- data/lib/shell_data_reporting_ap_is/models/invoice_dates_data.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_dates_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_dates_request_filters.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_dates_response_data.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_distribution_method.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_download_req.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_download_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_search_additional_document.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_search_details.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_search_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_search_request_filters.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_search_response.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_summary_details.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_summary_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_summary_request_filters.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoice_summary_response.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/invoices_summaries.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/last_statement_of_account.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/last_statement_of_account2.rb +457 -0
- data/lib/shell_data_reporting_ap_is/models/{error_user_access_error.rb → location.rb} +25 -22
- data/lib/shell_data_reporting_ap_is/models/logged_in_user_req.rb +63 -0
- data/lib/shell_data_reporting_ap_is/models/logged_in_user_res.rb +91 -0
- data/lib/shell_data_reporting_ap_is/models/logged_in_user_response.rb +6 -30
- data/lib/shell_data_reporting_ap_is/models/monthly_invoice_trend.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_req.rb +84 -0
- data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_request_accounts_items.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_res.rb +158 -0
- data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_response.rb +6 -57
- data/lib/shell_data_reporting_ap_is/models/multi_priced_transaction_response_transactions_items.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/o_auth_provider_error_enum.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/o_auth_token.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/past_statement_of_accounts.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/payer_access.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/payer_details.rb +8 -6
- data/lib/shell_data_reporting_ap_is/models/payer_req.rb +84 -0
- data/lib/shell_data_reporting_ap_is/models/payer_request.rb +6 -33
- data/lib/shell_data_reporting_ap_is/models/payer_res.rb +158 -0
- data/lib/shell_data_reporting_ap_is/models/payers.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/payments_since_last_soa.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/pin_advice_types.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/price_list.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/price_trans_summary_req.rb +62 -0
- data/lib/shell_data_reporting_ap_is/models/price_trans_summary_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/price_transaction_req.rb +84 -0
- data/lib/shell_data_reporting_ap_is/models/price_transaction_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/priced_request_data.rb +4 -8
- data/lib/shell_data_reporting_ap_is/models/priced_response_data.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/priced_trans_summary_resp.rb +116 -0
- data/lib/shell_data_reporting_ap_is/models/priced_trans_summary_response_transactions_summary_items.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_items_location_items.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_invoice_status_enum.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_period_enum.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_sort_order_enum.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb +5 -7
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_res.rb +158 -0
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_resp_v2_refund_flag_enum.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_response.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_response_transactions_items.rb +6 -27
- data/lib/shell_data_reporting_ap_is/models/priced_transaction_response_v2.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/pricing_current_volume.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/pricing_history.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/purchase_categories.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/recent_transaction_req.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/recent_transaction_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/recent_transactions.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/recent_transactions_response.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/role.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/search_doc_req.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/search_documents_invoice.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/search_documents_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/search_documents_response.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/search_soa_req.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/search_statement_of_account.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/search_statement_of_account_response.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/site_location.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/statement_of_account_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/statement_of_account_request_filters.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/statement_of_account_resp.rb +9 -9
- data/lib/shell_data_reporting_ap_is/models/statement_of_account_response.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/tier.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/transaction_exceptions.rb +5 -5
- data/lib/shell_data_reporting_ap_is/models/transaction_exceptions_req.rb +62 -0
- data/lib/shell_data_reporting_ap_is/models/transaction_exceptions_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/transaction_exceptions_res.rb +116 -0
- data/lib/shell_data_reporting_ap_is/models/transaction_exceptions_response.rb +6 -26
- data/lib/shell_data_reporting_ap_is/models/transaction_fees_req.rb +84 -0
- data/lib/shell_data_reporting_ap_is/models/transaction_fees_request.rb +6 -28
- data/lib/shell_data_reporting_ap_is/models/transaction_fees_res.rb +158 -0
- data/lib/shell_data_reporting_ap_is/models/transaction_fees_summary_req.rb +62 -0
- data/lib/shell_data_reporting_ap_is/models/update_odometer.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/update_odometer_reference.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/update_odometer_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/update_odometer_resp.rb +116 -0
- data/lib/shell_data_reporting_ap_is/models/update_odometer_response.rb +6 -26
- data/lib/shell_data_reporting_ap_is/models/usage_summary.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_req.rb +62 -0
- data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_res.rb +116 -0
- data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_response.rb +6 -27
- data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_req.rb +62 -0
- data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_request.rb +2 -2
- data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_res.rb +91 -0
- data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_response.rb +28 -24
- data/lib/shell_data_reporting_ap_is/models/warning.rb +69 -0
- data/lib/shell_data_reporting_ap_is/utilities/date_time_helper.rb +2 -2
- data/lib/shell_data_reporting_ap_is/utilities/file_wrapper.rb +2 -2
- data/lib/shell_data_reporting_ap_is/utilities/union_type_lookup.rb +2 -2
- data/lib/shell_data_reporting_ap_is.rb +54 -29
- data/test/controllers/controller_test_base.rb +2 -2
- data/test/controllers/test_invoice_controller.rb +3 -12
- data/test/controllers/test_transaction_controller.rb +3 -5
- data/test/http_response_catcher.rb +3 -3
- metadata +50 -26
- data/lib/shell_data_reporting_ap_is/exceptions/default_error_exception.rb +0 -44
- data/lib/shell_data_reporting_ap_is/exceptions/error_user_access_error1_exception.rb +0 -44
- data/lib/shell_data_reporting_ap_is/http/auth/basic_auth.rb +0 -50
- data/lib/shell_data_reporting_ap_is/models/account_response.rb +0 -123
- data/lib/shell_data_reporting_ap_is/models/card_group_response.rb +0 -121
- data/lib/shell_data_reporting_ap_is/models/card_type_response.rb +0 -91
- data/lib/shell_data_reporting_ap_is/models/card_type_response_error.rb +0 -71
- data/lib/shell_data_reporting_ap_is/models/default_error_fault.rb +0 -71
- data/lib/shell_data_reporting_ap_is/models/error_status.rb +0 -81
- data/lib/shell_data_reporting_ap_is/models/logged_in_user_request.rb +0 -121
- data/lib/shell_data_reporting_ap_is/models/payer_response.rb +0 -127
- data/lib/shell_data_reporting_ap_is/models/priced_trans_summary_response.rb +0 -91
- data/lib/shell_data_reporting_ap_is/models/transaction_fees_response.rb +0 -123
@@ -1,65 +1,61 @@
|
|
1
1
|
# shell_data_reporting_ap_is
|
2
2
|
#
|
3
|
-
# This file was automatically generated by
|
4
|
-
# ( https://apimatic.io ).
|
3
|
+
# This file was automatically generated by
|
4
|
+
# APIMATIC v3.0 ( https://www.apimatic.io ).
|
5
5
|
|
6
6
|
module ShellDataReportingApIs
|
7
7
|
# CustomerController
|
8
8
|
class CustomerController < BaseController
|
9
|
-
# This
|
10
|
-
# This
|
11
|
-
#
|
12
|
-
#
|
13
|
-
#
|
14
|
-
#
|
15
|
-
#
|
16
|
-
# specific environment which needs to be passed by the client.
|
9
|
+
# This operation allows querying the user data of the logged in user.
|
10
|
+
# This operation should be called only after successful authentication of
|
11
|
+
# the end user in client application. This operation will return the user
|
12
|
+
# access details such as payers and/or accounts.
|
13
|
+
# This operation will also validate that logged in user has access to the
|
14
|
+
# requested operation, on failure it will return HasAPIAccess flag as false
|
15
|
+
# in the response.
|
17
16
|
# @param [String] request_id Required parameter: Mandatory UUID (according
|
18
17
|
# to RFC 4122 standards) for requests and responses. This will be played
|
19
18
|
# back in the response from the request.
|
20
|
-
# @param [
|
21
|
-
#
|
22
|
-
# @return [
|
23
|
-
def
|
24
|
-
|
25
|
-
|
26
|
-
new_api_call_builder
|
19
|
+
# @param [LoggedInUserReq] body Required parameter: TODO: type description
|
20
|
+
# here
|
21
|
+
# @return [LoggedInUserRes] Response from the API call.
|
22
|
+
def user_loggedinuser(request_id,
|
23
|
+
body)
|
24
|
+
@api_call
|
27
25
|
.request(new_request_builder(HttpMethodEnum::POST,
|
28
|
-
'/
|
26
|
+
'/user-management/v1/loggedinuser',
|
29
27
|
Server::SHELL)
|
30
|
-
.header_param(new_parameter(apikey, key: 'apikey'))
|
31
28
|
.header_param(new_parameter(request_id, key: 'RequestId'))
|
32
29
|
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
33
30
|
.body_param(new_parameter(body))
|
34
31
|
.header_param(new_parameter('application/json', key: 'accept'))
|
35
32
|
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
36
|
-
.auth(Single.new('
|
33
|
+
.auth(Single.new('BearerToken')))
|
37
34
|
.response(new_response_handler
|
38
35
|
.deserializer(APIHelper.method(:custom_type_deserializer))
|
39
|
-
.deserialize_into(
|
36
|
+
.deserialize_into(LoggedInUserRes.method(:from_hash))
|
40
37
|
.local_error('400',
|
41
|
-
"The server cannot or will not process the request
|
42
|
-
' something that is perceived to be a client
|
43
|
-
' malformed request syntax, invalid
|
44
|
-
'
|
45
|
-
|
38
|
+
"The server cannot or will not process the request due to'\
|
39
|
+
' something that is perceived to be a client error (e.g.,'\
|
40
|
+
' malformed request syntax, invalid request message framing, or'\
|
41
|
+
' deceptive request routing).\n",
|
42
|
+
ErrorObjectException)
|
46
43
|
.local_error('401',
|
47
|
-
|
48
|
-
' authentication credentials for the target resource
|
49
|
-
|
44
|
+
"The request has not been applied because it lacks valid '\
|
45
|
+
' authentication credentials for the target resource.\n",
|
46
|
+
ErrorObjectException)
|
50
47
|
.local_error('403',
|
51
|
-
'
|
52
|
-
|
53
|
-
ErrorUserAccessError1Exception)
|
48
|
+
'Forbidden',
|
49
|
+
ErrorObjectException)
|
54
50
|
.local_error('404',
|
55
|
-
|
51
|
+
"The origin server did not find a current representation for'\
|
56
52
|
' the target resource or is not willing to disclose that one'\
|
57
|
-
' exists
|
58
|
-
|
53
|
+
' exists.\n",
|
54
|
+
ErrorObjectException)
|
59
55
|
.local_error('500',
|
60
|
-
|
61
|
-
' it from fulfilling the request
|
62
|
-
|
56
|
+
"The server encountered an unexpected condition that prevented'\
|
57
|
+
' it from fulfilling the request.\n",
|
58
|
+
ErrorObjectException))
|
63
59
|
.execute
|
64
60
|
end
|
65
61
|
|
@@ -72,336 +68,252 @@ module ShellDataReportingApIs
|
|
72
68
|
# be ignored and the API will return all the matching data by merging the
|
73
69
|
# data queried from each ColCo when payers passed in the input are from
|
74
70
|
# multiple ColCos.
|
75
|
-
# @param [String] apikey Required parameter: This is the API key of the
|
76
|
-
# specific environment which needs to be passed by the client.
|
77
71
|
# @param [String] request_id Required parameter: Mandatory UUID (according
|
78
72
|
# to RFC 4122 standards) for requests and responses. This will be played
|
79
73
|
# back in the response from the request.
|
80
|
-
# @param [
|
81
|
-
#
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
body: nil)
|
86
|
-
new_api_call_builder
|
74
|
+
# @param [PayerReq] body Required parameter: TODO: type description here
|
75
|
+
# @return [PayerRes] Response from the API call.
|
76
|
+
def customerpayers(request_id,
|
77
|
+
body)
|
78
|
+
@api_call
|
87
79
|
.request(new_request_builder(HttpMethodEnum::POST,
|
88
|
-
'/
|
80
|
+
'/customer-management/v1/payers',
|
89
81
|
Server::SHELL)
|
90
|
-
.header_param(new_parameter(apikey, key: 'apikey'))
|
91
82
|
.header_param(new_parameter(request_id, key: 'RequestId'))
|
92
83
|
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
93
84
|
.body_param(new_parameter(body))
|
94
85
|
.header_param(new_parameter('application/json', key: 'accept'))
|
95
86
|
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
96
|
-
.auth(Single.new('
|
87
|
+
.auth(Single.new('BearerToken')))
|
97
88
|
.response(new_response_handler
|
98
89
|
.deserializer(APIHelper.method(:custom_type_deserializer))
|
99
|
-
.deserialize_into(
|
90
|
+
.deserialize_into(PayerRes.method(:from_hash))
|
100
91
|
.local_error('400',
|
101
|
-
"The server cannot or will not process the request
|
102
|
-
' something that is perceived to be a client
|
103
|
-
' malformed request syntax, invalid
|
104
|
-
'
|
105
|
-
|
92
|
+
"The server cannot or will not process the request due to'\
|
93
|
+
' something that is perceived to be a client error (e.g.,'\
|
94
|
+
' malformed request syntax, invalid request message framing, or'\
|
95
|
+
' deceptive request routing).\n",
|
96
|
+
ErrorObjectException)
|
106
97
|
.local_error('401',
|
107
|
-
|
108
|
-
' authentication credentials for the target resource
|
109
|
-
|
98
|
+
"The request has not been applied because it lacks valid '\
|
99
|
+
' authentication credentials for the target resource.\n",
|
100
|
+
ErrorObjectException)
|
110
101
|
.local_error('403',
|
111
|
-
'
|
112
|
-
|
113
|
-
ErrorUserAccessError1Exception)
|
102
|
+
'Forbidden',
|
103
|
+
ErrorObjectException)
|
114
104
|
.local_error('404',
|
115
|
-
|
105
|
+
"The origin server did not find a current representation for'\
|
116
106
|
' the target resource or is not willing to disclose that one'\
|
117
|
-
' exists
|
118
|
-
|
107
|
+
' exists.\n",
|
108
|
+
ErrorObjectException)
|
119
109
|
.local_error('500',
|
120
|
-
|
121
|
-
' it from fulfilling the request
|
122
|
-
|
110
|
+
"The server encountered an unexpected condition that prevented'\
|
111
|
+
' it from fulfilling the request.\n",
|
112
|
+
ErrorObjectException))
|
123
113
|
.execute
|
124
114
|
end
|
125
115
|
|
126
116
|
# This API allows querying the card delivery addresses of a given account
|
127
|
-
# from the Shell Cards Platform.
|
128
|
-
#
|
129
|
-
# @param [String] apikey Required parameter: This is the API key of the
|
130
|
-
# specific environment which needs to be passed by the client.
|
131
|
-
# @param [String] request_id Required parameter: Mandatory UUID (according
|
132
|
-
# to RFC 4122 standards) for requests and responses. This will be played
|
133
|
-
# back in the response from the request.
|
134
|
-
# @param [CustomerDetailRequest] body Optional parameter: Customerdetails
|
135
|
-
# request body
|
136
|
-
# @return [CustomerDetailResponse] response from the API call.
|
137
|
-
def customer(apikey,
|
138
|
-
request_id,
|
139
|
-
body: nil)
|
140
|
-
new_api_call_builder
|
141
|
-
.request(new_request_builder(HttpMethodEnum::POST,
|
142
|
-
'/fleetmanagement/v1/customer/customer',
|
143
|
-
Server::SHELL)
|
144
|
-
.header_param(new_parameter(apikey, key: 'apikey'))
|
145
|
-
.header_param(new_parameter(request_id, key: 'RequestId'))
|
146
|
-
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
147
|
-
.body_param(new_parameter(body))
|
148
|
-
.header_param(new_parameter('application/json', key: 'accept'))
|
149
|
-
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
150
|
-
.auth(Single.new('BasicAuth')))
|
151
|
-
.response(new_response_handler
|
152
|
-
.deserializer(APIHelper.method(:custom_type_deserializer))
|
153
|
-
.deserialize_into(CustomerDetailResponse.method(:from_hash))
|
154
|
-
.local_error('400',
|
155
|
-
"The server cannot or will not process the request due to'\
|
156
|
-
' something that is perceived to be a client\r\n error (e.g.,'\
|
157
|
-
' malformed request syntax, invalid \r\n request message'\
|
158
|
-
' framing, or deceptive request routing).",
|
159
|
-
DefaultErrorException)
|
160
|
-
.local_error('401',
|
161
|
-
'The request has not been applied because it lacks valid '\
|
162
|
-
' authentication credentials for the target resource.',
|
163
|
-
DefaultErrorException)
|
164
|
-
.local_error('403',
|
165
|
-
'The server understood the request but refuses to authorize it'\
|
166
|
-
'.',
|
167
|
-
ErrorUserAccessError1Exception)
|
168
|
-
.local_error('404',
|
169
|
-
'The origin server did not find a current representation for'\
|
170
|
-
' the target resource or is not willing to disclose that one'\
|
171
|
-
' exists.',
|
172
|
-
DefaultErrorException)
|
173
|
-
.local_error('500',
|
174
|
-
'The server encountered an unexpected condition the prevented'\
|
175
|
-
' it from fulfilling the request.',
|
176
|
-
DefaultErrorException))
|
177
|
-
.execute
|
178
|
-
end
|
179
|
-
|
180
|
-
# - This operation fetches the International and National Price List and
|
181
|
-
# discount values set on pump prices & List Prices
|
182
|
-
# - It allows searching price list and discount values set on pump prices
|
183
|
-
# that are applicable for a given customer
|
184
|
-
# **Note**: Accounts with cancelled status will not be considered for this
|
185
|
-
# operation for the configured
|
186
|
-
# - When the search is based on customer specific price list then the
|
187
|
-
# customer price list is returned based on the associated pricing customer.
|
188
|
-
# - The discount values set on pump prices, which are returned by the
|
189
|
-
# operation are always customer specific values based on the customer
|
190
|
-
# associated price rules.
|
191
|
-
# @param [String] apikey Required parameter: This is the API key of the
|
192
|
-
# specific environment which needs to be passed by the client.
|
117
|
+
# from the Shell Cards Platform. Only active delivery addresses will be
|
118
|
+
# returned.
|
193
119
|
# @param [String] request_id Required parameter: Mandatory UUID (according
|
194
120
|
# to RFC 4122 standards) for requests and responses. This will be played
|
195
121
|
# back in the response from the request.
|
196
|
-
# @param [
|
197
|
-
#
|
198
|
-
# @return [
|
199
|
-
def
|
200
|
-
|
201
|
-
|
202
|
-
new_api_call_builder
|
122
|
+
# @param [CustomerReq] body Required parameter: TODO: type description
|
123
|
+
# here
|
124
|
+
# @return [CustomerRes] Response from the API call.
|
125
|
+
def customerdetail(request_id,
|
126
|
+
body)
|
127
|
+
@api_call
|
203
128
|
.request(new_request_builder(HttpMethodEnum::POST,
|
204
|
-
'/
|
129
|
+
'/customer-management/v1/customer',
|
205
130
|
Server::SHELL)
|
206
|
-
.header_param(new_parameter(apikey, key: 'apikey'))
|
207
131
|
.header_param(new_parameter(request_id, key: 'RequestId'))
|
208
132
|
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
209
133
|
.body_param(new_parameter(body))
|
210
134
|
.header_param(new_parameter('application/json', key: 'accept'))
|
211
135
|
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
212
|
-
.auth(Single.new('
|
136
|
+
.auth(Single.new('BearerToken')))
|
213
137
|
.response(new_response_handler
|
214
138
|
.deserializer(APIHelper.method(:custom_type_deserializer))
|
215
|
-
.deserialize_into(
|
139
|
+
.deserialize_into(CustomerRes.method(:from_hash))
|
216
140
|
.local_error('400',
|
217
|
-
"The server cannot or will not process the request
|
218
|
-
' something that is perceived to be a client
|
219
|
-
' malformed request syntax, invalid
|
220
|
-
'
|
221
|
-
|
141
|
+
"The server cannot or will not process the request due to'\
|
142
|
+
' something that is perceived to be a client error (e.g.,'\
|
143
|
+
' malformed request syntax, invalid request message framing, or'\
|
144
|
+
' deceptive request routing).\n",
|
145
|
+
ErrorObjectException)
|
222
146
|
.local_error('401',
|
223
|
-
|
224
|
-
' authentication credentials for the target resource
|
225
|
-
|
147
|
+
"The request has not been applied because it lacks valid '\
|
148
|
+
' authentication credentials for the target resource.\n",
|
149
|
+
ErrorObjectException)
|
226
150
|
.local_error('403',
|
227
|
-
'
|
228
|
-
|
229
|
-
ErrorUserAccessError1Exception)
|
151
|
+
'Forbidden',
|
152
|
+
ErrorObjectException)
|
230
153
|
.local_error('404',
|
231
|
-
|
154
|
+
"The origin server did not find a current representation for'\
|
232
155
|
' the target resource or is not willing to disclose that one'\
|
233
|
-
' exists
|
234
|
-
|
156
|
+
' exists.\n",
|
157
|
+
ErrorObjectException)
|
235
158
|
.local_error('500',
|
236
|
-
|
237
|
-
' it from fulfilling the request
|
238
|
-
|
159
|
+
"The server encountered an unexpected condition that prevented'\
|
160
|
+
' it from fulfilling the request.\n",
|
161
|
+
ErrorObjectException))
|
239
162
|
.execute
|
240
163
|
end
|
241
164
|
|
242
165
|
# This API allows querying the customer account details from the Shell Cards
|
243
|
-
# Platform.
|
244
|
-
# It provides a flexible search criterion and supports paging".
|
245
|
-
# @param [String] apikey Required parameter: This is the API key of the
|
246
|
-
# specific environment which needs to be passed by the client.
|
166
|
+
# Platform. It provides a flexible search criterion and supports pagination.
|
247
167
|
# @param [String] request_id Required parameter: Mandatory UUID (according
|
248
168
|
# to RFC 4122 standards) for requests and responses. This will be played
|
249
169
|
# back in the response from the request.
|
250
|
-
# @param [
|
251
|
-
# @return [
|
252
|
-
def
|
253
|
-
|
254
|
-
|
255
|
-
new_api_call_builder
|
170
|
+
# @param [AccountReq] body Required parameter: TODO: type description here
|
171
|
+
# @return [AccountRes] Response from the API call.
|
172
|
+
def post_card_accounts(request_id,
|
173
|
+
body)
|
174
|
+
@api_call
|
256
175
|
.request(new_request_builder(HttpMethodEnum::POST,
|
257
|
-
'/
|
176
|
+
'/customer-management/v1/accounts',
|
258
177
|
Server::SHELL)
|
259
|
-
.header_param(new_parameter(apikey, key: 'apikey'))
|
260
178
|
.header_param(new_parameter(request_id, key: 'RequestId'))
|
261
179
|
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
262
180
|
.body_param(new_parameter(body))
|
263
181
|
.header_param(new_parameter('application/json', key: 'accept'))
|
264
182
|
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
265
|
-
.auth(Single.new('
|
183
|
+
.auth(Single.new('BearerToken')))
|
266
184
|
.response(new_response_handler
|
267
185
|
.deserializer(APIHelper.method(:custom_type_deserializer))
|
268
|
-
.deserialize_into(
|
186
|
+
.deserialize_into(AccountRes.method(:from_hash))
|
269
187
|
.local_error('400',
|
270
|
-
"The server cannot or will not process the request
|
271
|
-
' something that is perceived to be a client
|
272
|
-
' malformed request syntax, invalid
|
273
|
-
'
|
274
|
-
|
188
|
+
"The server cannot or will not process the request due to'\
|
189
|
+
' something that is perceived to be a client error (e.g.,'\
|
190
|
+
' malformed request syntax, invalid request message framing, or'\
|
191
|
+
' deceptive request routing).\n",
|
192
|
+
ErrorObjectException)
|
275
193
|
.local_error('401',
|
276
|
-
|
277
|
-
' authentication credentials for the target resource
|
278
|
-
|
194
|
+
"The request has not been applied because it lacks valid '\
|
195
|
+
' authentication credentials for the target resource.\n",
|
196
|
+
ErrorObjectException)
|
279
197
|
.local_error('403',
|
280
|
-
'
|
281
|
-
|
282
|
-
ErrorUserAccessError1Exception)
|
198
|
+
'Forbidden',
|
199
|
+
ErrorObjectException)
|
283
200
|
.local_error('404',
|
284
|
-
|
201
|
+
"The origin server did not find a current representation for'\
|
285
202
|
' the target resource or is not willing to disclose that one'\
|
286
|
-
' exists
|
287
|
-
|
203
|
+
' exists.\n",
|
204
|
+
ErrorObjectException)
|
288
205
|
.local_error('500',
|
289
|
-
|
290
|
-
' it from fulfilling the request
|
291
|
-
|
206
|
+
"The server encountered an unexpected condition that prevented'\
|
207
|
+
' it from fulfilling the request.\n",
|
208
|
+
ErrorObjectException))
|
292
209
|
.execute
|
293
210
|
end
|
294
211
|
|
295
|
-
# This
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
212
|
+
# This API provides allows querying the active card types that are
|
213
|
+
# associated to the given account.
|
214
|
+
#
|
215
|
+
# The API returns the card type configurations, purchase categories
|
216
|
+
# associated with the card type and the card type restriction limits.
|
299
217
|
# @param [String] request_id Required parameter: Mandatory UUID (according
|
300
218
|
# to RFC 4122 standards) for requests and responses. This will be played
|
301
219
|
# back in the response from the request.
|
302
|
-
# @param [
|
303
|
-
#
|
304
|
-
# @return [
|
305
|
-
def
|
306
|
-
|
307
|
-
|
308
|
-
new_api_call_builder
|
220
|
+
# @param [CardTypeReq] body Required parameter: TODO: type description
|
221
|
+
# here
|
222
|
+
# @return [CardTypeRes] Response from the API call.
|
223
|
+
def customercardtypev(request_id,
|
224
|
+
body)
|
225
|
+
@api_call
|
309
226
|
.request(new_request_builder(HttpMethodEnum::POST,
|
310
|
-
'/
|
227
|
+
'/customer-management/v1/cardtype',
|
311
228
|
Server::SHELL)
|
312
|
-
.header_param(new_parameter(apikey, key: 'apikey'))
|
313
229
|
.header_param(new_parameter(request_id, key: 'RequestId'))
|
314
230
|
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
315
231
|
.body_param(new_parameter(body))
|
316
232
|
.header_param(new_parameter('application/json', key: 'accept'))
|
317
233
|
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
318
|
-
.auth(Single.new('
|
234
|
+
.auth(Single.new('BearerToken')))
|
319
235
|
.response(new_response_handler
|
320
236
|
.deserializer(APIHelper.method(:custom_type_deserializer))
|
321
|
-
.deserialize_into(
|
237
|
+
.deserialize_into(CardTypeRes.method(:from_hash))
|
322
238
|
.local_error('400',
|
323
|
-
"The server cannot or will not process the request
|
324
|
-
' something that is perceived to be a client
|
325
|
-
' malformed request syntax, invalid
|
326
|
-
'
|
327
|
-
|
239
|
+
"The server cannot or will not process the request due to'\
|
240
|
+
' something that is perceived to be a client error (e.g.,'\
|
241
|
+
' malformed request syntax, invalid request message framing, or'\
|
242
|
+
' deceptive request routing).\n",
|
243
|
+
ErrorObjectException)
|
328
244
|
.local_error('401',
|
329
|
-
|
330
|
-
' authentication credentials for the target resource
|
331
|
-
|
245
|
+
"The request has not been applied because it lacks valid '\
|
246
|
+
' authentication credentials for the target resource.\n",
|
247
|
+
ErrorObjectException)
|
332
248
|
.local_error('403',
|
333
|
-
'
|
334
|
-
|
335
|
-
ErrorUserAccessError1Exception)
|
249
|
+
'Forbidden',
|
250
|
+
ErrorObjectException)
|
336
251
|
.local_error('404',
|
337
|
-
|
252
|
+
"The origin server did not find a current representation for'\
|
338
253
|
' the target resource or is not willing to disclose that one'\
|
339
|
-
' exists
|
340
|
-
|
254
|
+
' exists.\n",
|
255
|
+
ErrorObjectException)
|
341
256
|
.local_error('500',
|
342
|
-
|
343
|
-
' it from fulfilling the request
|
344
|
-
|
257
|
+
"The server encountered an unexpected condition that prevented'\
|
258
|
+
' it from fulfilling the request.\n",
|
259
|
+
ErrorObjectException))
|
345
260
|
.execute
|
346
261
|
end
|
347
262
|
|
348
|
-
# This
|
349
|
-
# flexible search criteria and supports paging
|
350
|
-
# When the
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
# specific environment which needs to be passed by the client.
|
263
|
+
# This API allows querying the card group details from the Shell Cards
|
264
|
+
# Platform. It provides flexible search criteria and supports paging.
|
265
|
+
# When the account is not passed in the input and card group type is
|
266
|
+
# configured as
|
267
|
+
# ‘Vertical’ in the cards platform, this API will return all card groups
|
268
|
+
# from
|
269
|
+
# the payer as well as from all the accounts under the payer.
|
270
|
+
# When the account is not passed in the input and card group type is
|
271
|
+
# configured as
|
272
|
+
# ‘Horizontal’ in cards platform, this API will return all card groups
|
273
|
+
# configured directly under the payer.
|
360
274
|
# @param [String] request_id Required parameter: Mandatory UUID (according
|
361
275
|
# to RFC 4122 standards) for requests and responses. This will be played
|
362
276
|
# back in the response from the request.
|
363
|
-
# @param [
|
364
|
-
#
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
277
|
+
# @param [CardGroupReq] body Required parameter: TODO: type description
|
278
|
+
# here
|
279
|
+
# @return [CardGroupRes] Response from the API call.
|
280
|
+
def cardgroups(request_id,
|
281
|
+
body)
|
282
|
+
@api_call
|
369
283
|
.request(new_request_builder(HttpMethodEnum::POST,
|
370
|
-
'/
|
284
|
+
'/customer-management/v1/cardgroups',
|
371
285
|
Server::SHELL)
|
372
|
-
.header_param(new_parameter(apikey, key: 'apikey'))
|
373
286
|
.header_param(new_parameter(request_id, key: 'RequestId'))
|
374
287
|
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
375
288
|
.body_param(new_parameter(body))
|
376
289
|
.header_param(new_parameter('application/json', key: 'accept'))
|
377
290
|
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
378
|
-
.auth(Single.new('
|
291
|
+
.auth(Single.new('BearerToken')))
|
379
292
|
.response(new_response_handler
|
380
293
|
.deserializer(APIHelper.method(:custom_type_deserializer))
|
381
|
-
.deserialize_into(
|
294
|
+
.deserialize_into(CardGroupRes.method(:from_hash))
|
382
295
|
.local_error('400',
|
383
|
-
"The server cannot or will not process the request
|
384
|
-
' something that is perceived to be a client
|
385
|
-
' malformed request syntax, invalid
|
386
|
-
'
|
387
|
-
|
296
|
+
"The server cannot or will not process the request due to'\
|
297
|
+
' something that is perceived to be a client error (e.g.,'\
|
298
|
+
' malformed request syntax, invalid request message framing, or'\
|
299
|
+
' deceptive request routing).\n",
|
300
|
+
ErrorObjectException)
|
388
301
|
.local_error('401',
|
389
|
-
|
390
|
-
' authentication credentials for the target resource
|
391
|
-
|
302
|
+
"The request has not been applied because it lacks valid '\
|
303
|
+
' authentication credentials for the target resource.\n",
|
304
|
+
ErrorObjectException)
|
392
305
|
.local_error('403',
|
393
|
-
'
|
394
|
-
|
395
|
-
ErrorUserAccessError1Exception)
|
306
|
+
'Forbidden',
|
307
|
+
ErrorObjectException)
|
396
308
|
.local_error('404',
|
397
|
-
|
309
|
+
"The origin server did not find a current representation for'\
|
398
310
|
' the target resource or is not willing to disclose that one'\
|
399
|
-
' exists
|
400
|
-
|
311
|
+
' exists.\n",
|
312
|
+
ErrorObjectException)
|
401
313
|
.local_error('500',
|
402
|
-
|
403
|
-
' it from fulfilling the request
|
404
|
-
|
314
|
+
"The server encountered an unexpected condition that prevented'\
|
315
|
+
' it from fulfilling the request.\n",
|
316
|
+
ErrorObjectException))
|
405
317
|
.execute
|
406
318
|
end
|
407
319
|
|
@@ -421,57 +333,108 @@ module ShellDataReportingApIs
|
|
421
333
|
# * BCOSummary
|
422
334
|
# * BCOMultiAccountSummary
|
423
335
|
# * BCBSummary
|
424
|
-
# * Mobile Payment
|
425
|
-
# * Registration
|
336
|
+
# * Mobile Payment Registration
|
426
337
|
# * Fund Transfer (Scheduled & Realtime)
|
427
338
|
# * Delivery Address Update.
|
428
|
-
# @param [String] apikey Required parameter: This is the API key of the
|
429
|
-
# specific environment which needs to be passed by the client.
|
430
339
|
# @param [String] request_id Required parameter: Mandatory UUID (according
|
431
340
|
# to RFC 4122 standards) for requests and responses. This will be played
|
432
341
|
# back in the response from the request.
|
433
|
-
# @param [
|
434
|
-
# @return [AuditResponse]
|
435
|
-
def audit_report(
|
436
|
-
request_id,
|
342
|
+
# @param [AuditReq] body Optional parameter: request body
|
343
|
+
# @return [AuditResponse] Response from the API call.
|
344
|
+
def audit_report(request_id,
|
437
345
|
body: nil)
|
438
|
-
|
346
|
+
@api_call
|
439
347
|
.request(new_request_builder(HttpMethodEnum::POST,
|
440
|
-
'/
|
348
|
+
'/customer-management/v1/auditreport',
|
441
349
|
Server::SHELL)
|
442
|
-
.header_param(new_parameter(apikey, key: 'apikey'))
|
443
350
|
.header_param(new_parameter(request_id, key: 'RequestId'))
|
444
351
|
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
445
352
|
.body_param(new_parameter(body))
|
446
353
|
.header_param(new_parameter('application/json', key: 'accept'))
|
447
354
|
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
448
|
-
.auth(Single.new('
|
355
|
+
.auth(Single.new('BearerToken')))
|
449
356
|
.response(new_response_handler
|
450
357
|
.deserializer(APIHelper.method(:custom_type_deserializer))
|
451
358
|
.deserialize_into(AuditResponse.method(:from_hash))
|
452
359
|
.local_error('400',
|
453
|
-
"The server cannot or will not process the request
|
454
|
-
' something that is perceived to be a client
|
455
|
-
' malformed request syntax, invalid
|
456
|
-
'
|
457
|
-
|
360
|
+
"The server cannot or will not process the request due to'\
|
361
|
+
' something that is perceived to be a client error (e.g.,'\
|
362
|
+
' malformed request syntax, invalid request message framing, or'\
|
363
|
+
' deceptive request routing).\n",
|
364
|
+
ErrorObjectException)
|
365
|
+
.local_error('401',
|
366
|
+
"The request has not been applied because it lacks valid '\
|
367
|
+
' authentication credentials for the target resource.\n",
|
368
|
+
ErrorObjectException)
|
369
|
+
.local_error('403',
|
370
|
+
'Forbidden',
|
371
|
+
ErrorObjectException)
|
372
|
+
.local_error('404',
|
373
|
+
"The origin server did not find a current representation for'\
|
374
|
+
' the target resource or is not willing to disclose that one'\
|
375
|
+
' exists.\n",
|
376
|
+
ErrorObjectException)
|
377
|
+
.local_error('500',
|
378
|
+
"The server encountered an unexpected condition that prevented'\
|
379
|
+
' it from fulfilling the request.\n",
|
380
|
+
ErrorObjectException))
|
381
|
+
.execute
|
382
|
+
end
|
383
|
+
|
384
|
+
# - This operation fetches the International and National Price List and
|
385
|
+
# discount values set on pump prices & List Prices
|
386
|
+
# - It allows searching price list and discount values set on pump prices
|
387
|
+
# that are applicable for a given customer
|
388
|
+
# **Note**: Accounts with cancelled status will not be considered for this
|
389
|
+
# operation for the configured
|
390
|
+
# - When the search is based on customer specific price list then the
|
391
|
+
# customer price list is returned based on the associated pricing customer.
|
392
|
+
# - The discount values set on pump prices, which are returned by the
|
393
|
+
# operation are always customer specific values based on the customer
|
394
|
+
# associated price rules.
|
395
|
+
# @param [String] request_id Required parameter: Mandatory UUID (according
|
396
|
+
# to RFC 4122 standards) for requests and responses. This will be played
|
397
|
+
# back in the response from the request.
|
398
|
+
# @param [CustomerPriceListReq] body Optional parameter: Customerdetails
|
399
|
+
# request body
|
400
|
+
# @return [CustomerPriceListRes] Response from the API call.
|
401
|
+
def customer_price_list(request_id,
|
402
|
+
body: nil)
|
403
|
+
@api_call
|
404
|
+
.request(new_request_builder(HttpMethodEnum::POST,
|
405
|
+
'/customer-management/v1/pricelist',
|
406
|
+
Server::SHELL)
|
407
|
+
.header_param(new_parameter(request_id, key: 'RequestId'))
|
408
|
+
.header_param(new_parameter('application/json', key: 'Content-Type'))
|
409
|
+
.body_param(new_parameter(body))
|
410
|
+
.header_param(new_parameter('application/json', key: 'accept'))
|
411
|
+
.body_serializer(proc do |param| param.to_json unless param.nil? end)
|
412
|
+
.auth(Single.new('BearerToken')))
|
413
|
+
.response(new_response_handler
|
414
|
+
.deserializer(APIHelper.method(:custom_type_deserializer))
|
415
|
+
.deserialize_into(CustomerPriceListRes.method(:from_hash))
|
416
|
+
.local_error('400',
|
417
|
+
'The server cannot or will not process the request due to'\
|
418
|
+
' something that is perceived to be a client error (e.g.,'\
|
419
|
+
' malformed request syntax, invalid request message framing, or'\
|
420
|
+
' deceptive request routing).',
|
421
|
+
ErrorObjectException)
|
458
422
|
.local_error('401',
|
459
423
|
'The request has not been applied because it lacks valid '\
|
460
424
|
' authentication credentials for the target resource.',
|
461
|
-
|
425
|
+
ErrorObjectException)
|
462
426
|
.local_error('403',
|
463
|
-
'
|
464
|
-
|
465
|
-
ErrorUserAccessError1Exception)
|
427
|
+
'Forbidden',
|
428
|
+
ErrorObjectException)
|
466
429
|
.local_error('404',
|
467
430
|
'The origin server did not find a current representation for'\
|
468
431
|
' the target resource or is not willing to disclose that one'\
|
469
432
|
' exists.',
|
470
|
-
|
433
|
+
ErrorObjectException)
|
471
434
|
.local_error('500',
|
472
|
-
'The server encountered an unexpected condition
|
435
|
+
'The server encountered an unexpected condition that prevented'\
|
473
436
|
' it from fulfilling the request.',
|
474
|
-
|
437
|
+
ErrorObjectException))
|
475
438
|
.execute
|
476
439
|
end
|
477
440
|
end
|