Class: ShellDataReportingApIs::TransactionController
- Inherits:
-
BaseController
- Object
- BaseController
- ShellDataReportingApIs::TransactionController
- Defined in:
- lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb
Overview
TransactionController
Constant Summary
Constants inherited from BaseController
Instance Attribute Summary
Attributes inherited from BaseController
Instance Method Summary collapse
-
#card_usage_summary(request_id, body: nil) ⇒ CardUsageSummaryRes
This operation is to provide the expenditure analysis for a card for the past 7 months.
-
#fee_summary_response(request_id, body: nil) ⇒ FeeSummaryResponse
This API returns the summary data of the fee/charges levied from a customer’s account in a billing period or date range.
-
#fees(request_id, body: nil) ⇒ TransactionFeesRes
This API returns the fee/charges levied from a customer’s account in a billing period or date range.
-
#fuel_consumption(request_id, body: nil) ⇒ FuelConsumptionResponse
-
This API returns the customer an overview of how many transactions, how much fuel volume used over a given period and the total volume used by a card - This operation response will contains card & transaction details for given period aggregated by payer, account, cardGroup, PAN, DriverName and VRN to RFC 4122 standards) for requests and responses.
-
-
#multipriced_transactions(request_id, body: nil) ⇒ MultiPricedTransactionRes
This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items) for multiple payers.
-
#priced_transactions(request_id, body: nil) ⇒ PricedTransactionRes
This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items).
-
#priced_transactions_summary(request_id, body: nil) ⇒ PricedTransSummaryResp
This API returns the transaction summary data (i.e. Priced, Billed and Unbilled sales items).
-
#priced_transactions_v2(request_id, body: nil) ⇒ PricedTransactionResponseV2
This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items).
-
#recent_transactions_new(request_id, body: nil) ⇒ RecentTransactionsResponse
This endpoint allows querying last 48 hours of transaction data of Shell Card (i.e. Priced, Billed, Unbilled etc. sales items).
-
#transaction_exceptions(request_id, body: nil) ⇒ TransactionExceptionsRes
-
This API provides the details of the Cards or Transaction related exceptions based on the given conditions for the Requested period.
-
-
#update_odometer(request_id, body: nil) ⇒ UpdateOdometerResp
-
This API allows the users to update the odometer readings on the sales items (transaction data) - This is an asynchronous operation.
-
-
#volume_based_bonus(request_id, body: nil) ⇒ VolumeBasedBonusRes
-
This API provides the details of the bonus and/or association bonus rules setup for the given payer and that are active on the current date.
-
-
#volume_based_pricing(request_id, body: nil) ⇒ VolumeBasedPricingRes
-
This API will return the details of the in arrear fee rule applied to the payer along with details of locations, products, tiers as applied.
-
Methods inherited from BaseController
#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent
Constructor Details
This class inherits a constructor from ShellDataReportingApIs::BaseController
Instance Method Details
#card_usage_summary(request_id, body: nil) ⇒ CardUsageSummaryRes
This operation is to provide the expenditure analysis for a card for the past 7 months. The response contains a daily summary of the transactions (billed & unbilled) from 1st of the last 7 months for the requested card grouped by card, site-group and product. to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 269 def card_usage_summary(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/cardusagesummary', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(CardUsageSummaryRes.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#fee_summary_response(request_id, body: nil) ⇒ FeeSummaryResponse
This API returns the summary data of the fee/charges levied from a customer’s account in a billing period or date range. The API returns both billed and unbilled fee items. The endpoint supports the exact same search criteria as the endpoint transaction/feessummary. #### Supported operations
* Get fees by invoice status
* Get fees by date period
* Get fees by account
* Get fees by card Id or PAN
* Get fees by fee type charges
* Get fees including cancelled items
* Get fees by line item description
* Get fees by product
to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 490 def fee_summary_response(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/feessummary', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(FeeSummaryResponse.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#fees(request_id, body: nil) ⇒ TransactionFeesRes
This API returns the fee/charges levied from a customer’s account in a billing period or date range. The API returns both billed and unbilled fee items. To get the summary of charges, the endpoint transaction/feessummary should be called with the same input criteria. #### Supported operations
* Get fees by invoice status
* Get fees by date period
* Get fees by account
* Get fees by card Id or PAN
* Get fees by fee type charges
* Get fees including cancelled items
* Get fees by line item description
* Get fees by product
to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 430 def fees(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/fees', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(TransactionFeesRes.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#fuel_consumption(request_id, body: nil) ⇒ FuelConsumptionResponse
-
This API returns the customer an overview of how many transactions, how
much fuel volume used over a given period and the total volume used by a card
-
This operation response will contains card & transaction details for
given period aggregated by payer, account, cardGroup, PAN, DriverName and VRN to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 542 def fuel_consumption(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/fuelconsumption', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(FuelConsumptionResponse.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#multipriced_transactions(request_id, body: nil) ⇒ MultiPricedTransactionRes
This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items) for multiple payers. It provides a flexible search criteria and supports paging. Transactions that are posted but not yet priced, billed or that are in error will not be returned by this API. The API also supports returning Fee Items. At least one payer should be provided. Multiple payers must belong to the same payer group. #### Supported operations
* Get sales items and fee transactions for multiple payers
* Search by invoice status
* Search by fixed date period
* Search by date range
* Get sales items only for multiple payers
* Search by transaction location
* Search by transaction posting date
* Search by invoice number or date
* Search by fuel only transactions
This API fetches transactions for a period based on the below parameters
and priority order:
1. InvoiceNumber
2. InvoiceDate
3. FromDate, ToDate
4. PostingFromDate, PostingToDate (Can be used only when IncludeFees =
false)
5. InvoiceDateFrom, InvoiceDateTo
6. Period
This API considers only one of the above set of parameters at a time. For
example, if InvoiceNumber and Period are provided in the input then Period is ignored and transactions associated to the given invoice number are returned. If none of the above parameters are provided then last 7 days transactions will be fetched. to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 218 def multipriced_transactions(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/multipayerspricedtransactions', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(MultiPricedTransactionRes.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#priced_transactions(request_id, body: nil) ⇒ PricedTransactionRes
This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items). It provides a flexible search criteria and supports paging. Transactions that are posted but not yet priced, billed or that are in error will not be returned by this API. The API also supports returning Fee Items. #### Supported operations
* Get sales items and fee transactions
* Search by invoice status
* Search by fixed date period
* Search by date range
* Search by account
* Search by card
* Get sales items only
* Search by transaction Id or location
* Search by transaction posting date
* Search by invoice number or date
* Search by driver name or vehicle registration number
* Search by card group
* Search by fuel only transactions
* Search by product
This API fetches transactions for a period based on the below parameters
and priority order:
-
InvoiceNumber
-
InvoiceDate
-
FromDate, ToDate
-
PostingFromDate, PostingToDate (Can be used only when IncludeFees =
false)
5. InvoiceDateFrom, InvoiceDateTo
6. Period
This API considers only one of the above set of parameters at a time. For
example, if InvoiceNumber and Period are provided in the input then Period is ignored and transactions associated to the given invoice number are returned. If none of the above parameters are provided then last 7 days transactions will be fetched. This operation can fetch transactions that are old up to 24 (configurable) months. However, the date range between any of the ‘From’ and ‘To’ dates in the above combination cannot be more than 210 (configurable) days. to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. Request Body
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 55 def priced_transactions(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/pricedtransaction', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(PricedTransactionRes.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#priced_transactions_summary(request_id, body: nil) ⇒ PricedTransSummaryResp
This API returns the transaction summary data (i.e. Priced, Billed and Unbilled sales items). It provides a flexible search criteria. The API also supports returning Fee Items. Transactions posted for fee items that are in error are not included in the summary. The endpoint supports the exact same search criteria as the endpoint transaction/prciedtransactions. #### Supported operations
* Get sales items and fee transactions
* Search by invoice status
* Search by fixed date period
* Search by date range
* Search by account
* Search by card
* Get sales items only
* Search by transaction Id or location
* Search by transaction posting date
* Search by invoice number or date
* Search by driver name or vehicle registration number
* Search by card group
* Search by fuel only transactions
* Search by product
This API fetches transactions for a period based on the below parameters
and priority order:
1. InvoiceNumber
2. InvoiceDate
3. FromDate, ToDate
4. PostingFromDate, PostingToDate (Can be used only when IncludeFees =
false)
5. InvoiceDateFrom, InvoiceDateTo
6. Period
This API considers only one of the above set of parameters at a time. For
example, if InvoiceNumber and Period are provided in the input then Period is ignored and transactions associated to the given invoice number are returned. If none of the above parameters are provided then last 7 days transactions will be fetched. to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 138 def priced_transactions_summary(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/pricedtransactionssummary', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(PricedTransSummaryResp.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#priced_transactions_v2(request_id, body: nil) ⇒ PricedTransactionResponseV2
This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items). It provides a flexible search criteria and supports paging. The version 2 is an enhancement to the version 1 where EV transactions and their details are added in the response. Transactions that are posted but not yet priced, billed or that are in error will not be returned by this API. The API also supports returning Fee Items. #### Supported operations
* Get sales items and fee transactions
* Search by invoice status
* Search by fixed date period
* Search by date range
* Search by account
* Search by card
* Get sales items only
* Search by transaction Id or location
* Search by transaction posting date
* Search by invoice number or date
* Search by driver name or vehicle registration number
* Search by card group
* Search by fuel only transactions
* Search by product
* EV transaction details - Below are EV specific parameters
* EVOperator
* EVSerialId
* EVChargePointSerial
* EVChargePointConnectorType
* EVChargePointConnectorTypeDescription
* EVChargeDuration
* EVChargeStartDate
* EVChargeStartTime
* EVChargeEndDate
* EVChargeEndTime
to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. TransactionV2 RequestBody
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 783 def priced_transactions_v2(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/priced', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(PricedTransactionResponseV2.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#recent_transactions_new(request_id, body: nil) ⇒ RecentTransactionsResponse
This endpoint allows querying last 48 hours of transaction data of Shell Card (i.e. Priced, Billed, Unbilled etc. sales items). It provides a flexible search criteria and supports pagination. E.g., if the request is made at 08:30 AM on 18 Aug 2022 then transactions until 16 Aug 2022 08:30 AM (including) can be retrieved. #### Supported operations
* Search by Date and Time range (within the last 48 hours only)
* Search by Payer and/or Account number
* Search by Card
* Search by Purchased Country
* Search by Transaction posting date
* Search by Driver Name or Vehicle registration number
* Search by Fuel only transactions
* Search by Product and/or Product group
to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. Transaction RequestBody
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 703 def recent_transactions_new(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/recent', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(RecentTransactionsResponse.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#transaction_exceptions(request_id, body: nil) ⇒ TransactionExceptionsRes
-
This API provides the details of the Cards or Transaction related
exceptions based on the given conditions for the Requested period.
-
This API will return the Transactions related exceptions when the
OutputType input parameter is passed as ‘Transaction’ else will return the Cards related exceptions. to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. Exceptions RequestBody
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 643 def transaction_exceptions(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/exceptions', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(TransactionExceptionsRes.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#update_odometer(request_id, body: nil) ⇒ UpdateOdometerResp
-
This API allows the users to update the odometer readings on the sales
items (transaction data)
-
This is an asynchronous operation. If opted, the user will be notified
on completion of processing. to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 592 def update_odometer(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/updateodometer', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(UpdateOdometerResp.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#volume_based_bonus(request_id, body: nil) ⇒ VolumeBasedBonusRes
-
This API provides the details of the bonus and/or association bonus
rules setup for the given payer and that are active on the current date.
-
This API also returns the details of the monthly breakup of current
period consumption as well as the details of the previously calculated bonus and consumption of the applicable payers. to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 320 def volume_based_bonus(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/volumebasedbonuss', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(VolumeBasedBonusRes.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |
#volume_based_pricing(request_id, body: nil) ⇒ VolumeBasedPricingRes
-
This API will return the details of the in arrear fee rule applied to
the payer along with details of locations, products, tiers as applied.
-
It will also show historical and current volume consumption and related
tier applied for the following month. to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. RequestBody
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'lib/shell_data_reporting_ap_is/controllers/transaction_controller.rb', line 370 def volume_based_pricing(request_id, body: nil) @api_call .request(new_request_builder(HttpMethodEnum::POST, '/transaction-data/v1/volumebasedpricing', Server::SHELL) .header_param(new_parameter(request_id, key: 'RequestId')) .header_param(new_parameter('application/json', key: 'Content-Type')) .body_param(new_parameter(body)) .header_param(new_parameter('application/json', key: 'accept')) .body_serializer(proc do |param| param.to_json unless param.nil? end) .auth(Single.new('BearerToken'))) .response(new_response_handler .deserializer(APIHelper.method(:custom_type_deserializer)) .deserialize_into(VolumeBasedPricingRes.method(:from_hash)) .local_error('400', 'The server cannot or will not process the request due to'\ ' something that is perceived to be a client error (e.g.,'\ ' malformed request syntax, invalid request message framing, or'\ ' deceptive request routing).', ErrorObjectException) .local_error('401', 'The request has not been applied because it lacks valid '\ ' authentication credentials for the target resource.', ErrorObjectException) .local_error('403', 'Forbidden', ErrorObjectException) .local_error('404', 'The origin server did not find a current representation for'\ ' the target resource or is not willing to disclose that one'\ ' exists.', ErrorObjectException) .local_error('500', 'The server encountered an unexpected condition that prevented'\ ' it from fulfilling the request.', ErrorObjectException)) .execute end |