card-management-sdk 1.4.0 → 2.0.0

data/lib/shell_card_management_ap_is/controllers/card_controller.rb

@@ -1,7 +1,7 @@
 # shell_card_management_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellCardManagementApIs
   # CardController
@@ -32,10 +32,10 @@ module ShellCardManagementApIs
     # to RFC 4122 standards) for requests and responses. This will be played
     # back in the response from the request.
     # @param [SearchCardRequest] body Optional parameter: requestbody
-    # @return [CardSearchResponse] response from the API call.
+    # @return [CardSearchResponse] Response from the API call.
     def search_card(request_id,
                     body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/search',
                                      Server::SHELL)
@@ -53,23 +53,23 @@ module ShellCardManagementApIs
                                   ' something that is perceived to be a client error (e.g.,'\
                                   ' malformed request syntax, invalid request message framing, or'\
                                   ' deceptive request routing).',
-                                 ErrorObjectException)
+                                 ErrorObjectErrorException)
                     .local_error('401',
                                  'The request has not been applied because it lacks valid '\
                                   ' authentication credentials for the target resource.',
-                                 ErrorObjectException)
+                                 ErrorObjectErrorException)
                     .local_error('403',
                                  'Forbidden',
-                                 ErrorObjectException)
+                                 ErrorObjectErrorException)
                     .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)
+                                 ErrorObjectErrorException)
                     .local_error('500',
                                  'The server encountered an unexpected condition that  prevented'\
                                   ' it from fulfilling the request.',
-                                 ErrorObjectException))
+                                 ErrorObjectErrorException))
         .execute
     end
 
@@ -92,10 +92,10 @@ module ShellCardManagementApIs
     # back in the response from the request.
     # @param [CardSummaryRequest] body Optional parameter: summary request
     # body
-    # @return [CardSummaryResponse] response from the API call.
+    # @return [CardSummaryResponse] Response from the API call.
     def card_summary(request_id,
                      body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/summary',
                                      Server::SHELL)
@@ -113,7 +113,7 @@ module ShellCardManagementApIs
                                   ' something that is perceived to be a client error (e.g.,'\
                                   ' malformed request syntax, invalid request message framing, or'\
                                   ' deceptive request routing).',
-                                 ErrorObjectException)
+                                 ErrorObjectErrorException)
                     .local_error('401',
                                  'The request has not been applied because it lacks valid '\
                                   ' authentication credentials for the target resource.',
@@ -129,7 +129,7 @@ module ShellCardManagementApIs
                     .local_error('500',
                                  'The server encountered an unexpected condition that  prevented'\
                                   ' it from fulfilling the request.',
-                                 ErrorObjectException))
+                                 ErrorObjectErrorException))
         .execute
     end
 
@@ -171,10 +171,10 @@ module ShellCardManagementApIs
     # back in the response from the request.
     # @param [CardManagementV1OrdercardRequest] body Optional parameter: Order
     # card request body
-    # @return [OrderCardResponse] response from the API call.
+    # @return [OrderCardResponse] Response from the API call.
     def order_card(request_id,
                    body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/ordercard',
                                      Server::SHELL)
@@ -227,10 +227,10 @@ module ShellCardManagementApIs
     # back in the response from the request.
     # @param [OrderCardEnquiryRequest] body Optional parameter: Order Card
     # Enquiry request body
-    # @return [OrderCardEnquiryResponse] response from the API call.
+    # @return [OrderCardEnquiryResponse] Response from the API call.
     def order_card_enquiry(request_id,
                            body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/ordercardenquiry',
                                      Server::SHELL)
@@ -316,10 +316,10 @@ module ShellCardManagementApIs
     # back in the response from the request.
     # @param [CardManagementV1CancelRequest] body Optional parameter: Update
     # status request body
-    # @return [CancelCardResponse] response from the API call.
+    # @return [CancelCardResponse] Response from the API call.
     def card_cancel(request_id,
                     body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/cancel',
                                      Server::SHELL)
@@ -337,7 +337,7 @@ module ShellCardManagementApIs
                                   ' something that is perceived to be a client error (e.g.,'\
                                   ' malformed request syntax, invalid request message framing, or'\
                                   ' deceptive request routing).',
-                                 ErrorObjectException)
+                                 ErrorObjectErrorException)
                     .local_error('401',
                                  'The request has not been applied because it lacks valid '\
                                   ' authentication credentials for the target resource.',
@@ -429,10 +429,10 @@ module ShellCardManagementApIs
     # back in the response from the request.
     # @param [CardManagementV1UpdatestatusRequest] body Optional parameter:
     # Update status request body
-    # @return [UpdateCardStatusResponse] response from the API call.
+    # @return [UpdateCardStatusResponse] Response from the API call.
     def card_update_status(request_id,
                            body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/updatestatus',
                                      Server::SHELL)
@@ -476,22 +476,18 @@ module ShellCardManagementApIs
     # categories on it’s response.
     #   *  List of fuel and non-fuel product sets associated.
     #   *  List of products configured in each product set
-    # @param [String] apikey Required parameter: This is the API key of the
-    # specific environment which needs to be passed by the client.
     # @param [String] request_id Required parameter: Mandatory UUID (according
     # to RFC 4122 standards) for requests and responses. This will be played
     # back in the response from the request.
-    # @param [PurchaseCategoryRequest] body Optional parameter: PurchaseCategory
+    # @param [PurchaseCategoryReq] body Optional parameter: PurchaseCategory
     # request body
-    # @return [PurchaseCategoryResponse] response from the API call.
-    def purchase_category(apikey,
-                          request_id,
+    # @return [PurchaseCategoryRes] Response from the API call.
+    def purchase_category(request_id,
                           body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/fleetmanagement/v1/master/purchasecategory',
+                                     '/config-data/v1/purchasecategory',
                                      Server::SHELL)
-                   .header_param(new_parameter(apikey, key: 'apikey'))
                    .header_param(new_parameter(request_id, key: 'RequestId'))
                    .header_param(new_parameter('application/json', key: 'Content-Type'))
                    .body_param(new_parameter(body))
@@ -500,30 +496,29 @@ module ShellCardManagementApIs
                    .auth(Single.new('BearerToken')))
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
-                    .deserialize_into(PurchaseCategoryResponse.method(:from_hash))
+                    .deserialize_into(PurchaseCategoryRes.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\r\n error (e.g.,'\
-                                  ' malformed request syntax, invalid \r\n request message'\
-                                  ' framing, or deceptive request routing).",
-                                 APIException)
+                                 "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).\n",
+                                 ErrorObjectErrorException)
                     .local_error('401',
-                                 'The request has not been applied because it lacks valid '\
-                                  ' authentication credentials for the target resource.',
-                                 APIException)
+                                 "The request has not been applied because it lacks valid '\
+                                  ' authentication credentials for the target resource.\n",
+                                 ErrorObjectErrorException)
                     .local_error('403',
-                                 'The server understood the request but refuses to authorize it'\
-                                  '.',
-                                 APIException)
+                                 'Forbidden',
+                                 ErrorObjectErrorException)
                     .local_error('404',
-                                 'The origin server did not find a current representation  for'\
+                                 "The origin server did not find a current representation  for'\
                                   ' the target resource or is not willing to disclose  that one'\
-                                  ' exists.',
-                                 APIException)
+                                  ' exists.\n",
+                                 ErrorObjectErrorException)
                     .local_error('500',
-                                 'The server encountered an unexpected condition the prevented'\
-                                  ' it from fulfilling the request.',
-                                 APIException))
+                                 "The server encountered an unexpected condition that  prevented'\
+                                  ' it from fulfilling the request.\n",
+                                 ErrorObjectErrorException))
         .execute
     end
 
@@ -533,23 +528,19 @@ module ShellCardManagementApIs
     # result in multiple fuel cards matching the search criteria. The card
     # details of the most recently issued card will be returned.
     #   #### Supported operations
-    #   * Get card by card id or PAN
-    # @param [String] apikey Required parameter: This is the API key of the
-    # specific environment which needs to be passed by the client.
-    # @param [String] request_id Required parameter: Mandatory UUID (according
-    # to RFC 4122 standards) for requests and responses. This will be played
-    # back in the response from the request.
-    # @param [CardDetailsRequest] body Optional parameter: Card details request
+    #   * Get card by card id or PAN or PANID
+    # @param [String] request_id Required parameter: UUID (according to RFC 4122
+    # standards) for requests and responses. This will be played back in the
+    # response from the request.
+    # @param [CardDetailsReq] body Required parameter: Card Details request
     # body
-    # @return [CardDetailsResponse] response from the API call.
-    def card_details(apikey,
-                     request_id,
-                     body: nil)
-      new_api_call_builder
+    # @return [CardDetailsResponse] Response from the API call.
+    def card_details(request_id,
+                     body)
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/fleetmanagement/v1/card/card',
+                                     '/card-management/v1/details',
                                      Server::SHELL)
-                   .header_param(new_parameter(apikey, key: 'apikey'))
                    .header_param(new_parameter(request_id, key: 'RequestId'))
                    .header_param(new_parameter('application/json', key: 'Content-Type'))
                    .body_param(new_parameter(body))
@@ -560,28 +551,27 @@ module ShellCardManagementApIs
                     .deserializer(APIHelper.method(:custom_type_deserializer))
                     .deserialize_into(CardDetailsResponse.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\r\n error (e.g.,'\
-                                  ' malformed request syntax, invalid \r\n request message'\
-                                  ' framing, or deceptive request routing).",
-                                 APIException)
+                                 "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).\n",
+                                 ErrorObjectErrorException)
                     .local_error('401',
-                                 'The request has not been applied because it lacks valid '\
-                                  ' authentication credentials for the target resource.',
-                                 APIException)
+                                 "The request has not been applied because it lacks valid '\
+                                  ' authentication credentials for the target resource.\n",
+                                 ErrorObjectErrorException)
                     .local_error('403',
-                                 'The server understood the request but refuses to authorize it'\
-                                  '.',
-                                 APIException)
+                                 'Forbidden',
+                                 ErrorObjectErrorException)
                     .local_error('404',
-                                 'The origin server did not find a current representation  for'\
+                                 "The origin server did not find a current representation  for'\
                                   ' the target resource or is not willing to disclose  that one'\
-                                  ' exists.',
-                                 APIException)
+                                  ' exists.\n",
+                                 ErrorObjectErrorException)
                     .local_error('500',
-                                 'The server encountered an unexpected condition the prevented'\
-                                  ' it from fulfilling the request.',
-                                 APIException))
+                                 "The server encountered an unexpected condition that  prevented'\
+                                  ' it from fulfilling the request.\n",
+                                 ErrorObjectErrorException))
         .execute
     end
 
@@ -595,7 +585,7 @@ module ShellCardManagementApIs
     #   * Removing a card from a card group
     # #### Validation rules
     #   * Number of cards per request does not exceed 500
-    #   * Given **PAN** for a card matches with only one card
+    #   * Given **PANID** or **PAN** for a card matches with only one card
     #   * A card is allowed to be moved to the **TargetCardGroupId** or
     # **TargetAccountNumber**
     #   * A pending move request does not exist in the queue for a card
@@ -612,22 +602,19 @@ module ShellCardManagementApIs
     # #### Asynchronous processing of valid API request
     #   * Move card requests that have been submitted and processed will be
     # reflected after midnight according to the customers local date
-    # @param [String] apikey Required parameter: This is the API key of the
-    # specific environment which needs to be passed by the client.
-    # @param [String] request_id Required parameter: Mandatory UUID (according
-    # to RFC 4122 standards) for requests and responses. This will be played
-    # back in the response from the request.
-    # @param [CardMoveRequest] body Optional parameter: Move cards request
-    # body.
-    # @return [CardMoveResponse] response from the API call.
-    def card_move(apikey,
-                  request_id,
-                  body: nil)
-      new_api_call_builder
+    # 
+    # @param [String] request_id Required parameter: UUID (according to RFC 4122
+    # standards) for requests and responses. This will be played back in the
+    # response from the request.
+    # @param [CardMoveRequest] body Required parameter: schedulecardblock
+    # request body
+    # @return [CardMoveRes] Response from the API call.
+    def card_move(request_id,
+                  body)
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/fleetmanagement/v1/card/move',
+                                     '/card-management/v1/move',
                                      Server::SHELL)
-                   .header_param(new_parameter(apikey, key: 'apikey'))
                    .header_param(new_parameter(request_id, key: 'RequestId'))
                    .header_param(new_parameter('application/json', key: 'Content-Type'))
                    .body_param(new_parameter(body))
@@ -636,30 +623,29 @@ module ShellCardManagementApIs
                    .auth(Single.new('BearerToken')))
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
-                    .deserialize_into(CardMoveResponse.method(:from_hash))
+                    .deserialize_into(CardMoveRes.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\r\n error (e.g.,'\
-                                  ' malformed request syntax, invalid \r\n request message'\
-                                  ' framing, or deceptive request routing).",
-                                 APIException)
+                                 "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).\n",
+                                 ErrorObjectErrorException)
                     .local_error('401',
-                                 'The request has not been applied because it lacks valid '\
-                                  ' authentication credentials for the target resource.',
-                                 APIException)
+                                 "The request has not been applied because it lacks valid '\
+                                  ' authentication credentials for the target resource.\n",
+                                 ErrorObjectErrorException)
                     .local_error('403',
-                                 'The server understood the request but refuses to authorize it'\
-                                  '.',
-                                 APIException)
+                                 'Forbidden',
+                                 ErrorObjectErrorException)
                     .local_error('404',
-                                 'The origin server did not find a current representation  for'\
+                                 "The origin server did not find a current representation  for'\
                                   ' the target resource or is not willing to disclose  that one'\
-                                  ' exists.',
-                                 APIException)
+                                  ' exists.\n",
+                                 ErrorObjectErrorException)
                     .local_error('500',
-                                 'The server encountered an unexpected condition the prevented'\
-                                  ' it from fulfilling the request.',
-                                 APIException))
+                                 "The server encountered an unexpected condition that  prevented'\
+                                  ' it from fulfilling the request.\n",
+                                 ErrorObjectErrorException))
         .execute
     end
 
@@ -694,10 +680,10 @@ module ShellCardManagementApIs
     # back in the response from the request.
     # @param [CardManagementV1PinreminderRequest] body Optional parameter: PIN
     # reminder request body
-    # @return [PINReminderResponse] response from the API call.
+    # @return [PINReminderResponse] Response from the API call.
     def card_pin_reminder(request_id,
                           body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/pinreminder',
                                      Server::SHELL)
@@ -715,23 +701,23 @@ module ShellCardManagementApIs
                                   ' something that is perceived to be a client error (e.g.,'\
                                   ' malformed request syntax, invalid request message framing, or'\
                                   ' deceptive request routing).',
-                                 ErrorObjectException)
+                                 ErrorObjectErrorException)
                     .local_error('401',
                                  'The request has not been applied because it lacks valid '\
                                   ' authentication credentials for the target resource.',
-                                 ErrorObjectException)
+                                 ErrorObjectErrorException)
                     .local_error('403',
                                  'Forbidden',
-                                 ErrorObjectException)
+                                 ErrorObjectErrorException)
                     .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)
+                                 ErrorObjectErrorException)
                     .local_error('500',
                                  'The server encountered an unexpected condition that  prevented'\
                                   ' it from fulfilling the request.',
-                                 ErrorObjectException))
+                                 ErrorObjectErrorException))
         .execute
     end
 
@@ -781,10 +767,10 @@ module ShellCardManagementApIs
     # to RFC 4122 standards) for requests and responses. This will be played
     # back in the response from the request.
     # @param [ScheduleCardBlockRequest] body Optional parameter: request body
-    # @return [ScheduleCardBlockResponse] response from the API call.
+    # @return [ScheduleCardBlockResponse] Response from the API call.
     def schedule_card_block(request_id,
                             body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/schedulecardblock',
                                      Server::SHELL)
@@ -848,10 +834,10 @@ module ShellCardManagementApIs
     # back in the response from the request.
     # @param [AutoRenewCardRequest] body Optional parameter: Auto renew request
     # body
-    # @return [AutoRenewCardResponse] response from the API call.
+    # @return [AutoRenewCardResponse] Response from the API call.
     def auto_renew(request_id,
                    body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/autorenew',
                                      Server::SHELL)
@@ -901,10 +887,10 @@ module ShellCardManagementApIs
     # back in the response from the request.
     # @param [UpdateMPayRegStatusRequest] body Optional parameter: Request
     # body
-    # @return [UpdateMPayRegStatusResponse] response from the API call.
+    # @return [UpdateMPayRegStatusResponse] Response from the API call.
     def update_mobile_payment_registration_status(request_id,
                                                   body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/card-management/v1/updatemobilepaymentregistrationstatus',
                                      Server::SHELL)
@@ -922,7 +908,7 @@ module ShellCardManagementApIs
                                   ' something that is perceived to be a client error (e.g.,'\
                                   ' malformed request syntax, invalid request message framing, or'\
                                   ' deceptive request routing).',
-                                 ErrorObjectException)
+                                 ErrorObjectErrorException)
                     .local_error('401',
                                  'The request has not been applied because it lacks valid '\
                                   ' authentication credentials for the target resource.',
@@ -953,10 +939,10 @@ module ShellCardManagementApIs
     # true. If the parameter is true then public Key will be valid for 90 days.
     # If the parameter is false then the key will be valid for one time. default
     # value will be false.
-    # @return [GeneratePINKeyResponse] response from the API call.
+    # @return [GeneratePINKeyResponse] Response from the API call.
     def get_key(request_id,
                 fleet: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/pin-management/v1/generatepinkeys',
                                      Server::SHELL)
@@ -998,49 +984,50 @@ module ShellCardManagementApIs
     # PIN reminder is requested)
     # #### Supported operations
     #   * card delivery address update
-    # @param [String] apikey Required parameter: This is the API key of the
-    # specific environment which needs to be passed by the client.
-    # @param [DeliveryAddressUpdateRequest] body Optional parameter: Delivery
-    # Address Update Request Body
-    # @return [DeliveryAddressUpdateResponse] response from the API call.
-    def delivery_address_update(apikey,
-                                body: nil)
-      new_api_call_builder
+    # 
+    # @param [String] request_id Required parameter: UUID (according to RFC 4122
+    # standards) for requests and responses. This will be played back in the
+    # response from the request.
+    # @param [DeliveryAddressUpdateRequest] body Required parameter: Delivery
+    # Address update request body
+    # @return [ResponseDeliveryAddressUpdate] Response from the API call.
+    def deliveryaddressupdate_v2(request_id,
+                                 body)
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/fleetmanagement/v1/card/deliveryaddressupdate',
+                                     '/card-management/v1/deliveryaddressupdate',
                                      Server::SHELL)
-                   .header_param(new_parameter(apikey, key: 'apikey'))
+                   .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('BasicAuth')))
+                   .auth(Single.new('BearerToken')))
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
-                    .deserialize_into(DeliveryAddressUpdateResponse.method(:from_hash))
+                    .deserialize_into(ResponseDeliveryAddressUpdate.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\r\n error (e.g.,'\
-                                  ' malformed request syntax, invalid \r\n request message'\
-                                  ' framing, or deceptive request routing).",
-                                 APIException)
+                                 "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).\n",
+                                 ErrorObjectErrorException)
                     .local_error('401',
-                                 'The request has not been applied because it lacks valid '\
-                                  ' authentication credentials for the target resource.',
-                                 APIException)
+                                 "The request has not been applied because it lacks valid '\
+                                  ' authentication credentials for the target resource.\n",
+                                 ErrorObjectErrorException)
                     .local_error('403',
-                                 'The server understood the request but refuses to authorize it'\
-                                  '.',
-                                 APIException)
+                                 'Forbidden',
+                                 ErrorObjectErrorException)
                     .local_error('404',
-                                 'The origin server did not find a current representation  for'\
+                                 "The origin server did not find a current representation  for'\
                                   ' the target resource or is not willing to disclose  that one'\
-                                  ' exists.',
-                                 APIException)
+                                  ' exists.\n",
+                                 ErrorObjectErrorException)
                     .local_error('500',
-                                 'The server encountered an unexpected condition the prevented'\
-                                  ' it from fulfilling the request.',
-                                 APIException))
+                                 "The server encountered an unexpected condition that  prevented'\
+                                  ' it from fulfilling the request.\n",
+                                 ErrorObjectErrorException))
         .execute
     end
   end