walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/apis/shipping_api.rb

@@ -0,0 +1,380 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ShippingApi
+  class ShippingApi < BaseApi
+    # Returns a list of shipping rate quotes for the given shipment
+    # request. The seller can then call purchaseShipment with the
+    # selected rateId to commit to a label purchase.
+    # @param [GetRatesRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_rates(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/shipping/v4/shipments/rates',
+                                     Server::DEFAULT1)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetFulfillmentOrderResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Purchases the shipping label for the rate selected from a prior
+    # getRates response. Returns the shipment record with label
+    # document references.
+    # @param [PurchaseShipmentRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def purchase_shipment(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/shipping/v4/shipments',
+                                     Server::DEFAULT1)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetFulfillmentOrderShipmentsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Convenience endpoint that combines rate quote and purchase into
+    # a single round trip when the seller already knows the desired
+    # service level. Returns the purchased shipment record directly.
+    # @param [OneClickShipmentRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def one_click_shipment(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/shipping/v4/oneClickShipment',
+                                     Server::DEFAULT1)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetFulfillmentOrderShipmentsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Returns the current tracking status, event history, and any
+    # proof-of-delivery details for the given trackingId/carrierId
+    # pair.
+    # @param [String] tracking_id Required parameter: Tracking identifier
+    # returned by purchaseShipment.
+    # @param [String] carrier_id Required parameter: Carrier identifier whose
+    # tracking is being requested.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_tracking(tracking_id,
+                     carrier_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipping/v4/tracking',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(tracking_id, key: 'trackingId')
+                                 .is_required(true))
+                   .query_param(new_parameter(carrier_id, key: 'carrierId')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetTrackingResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Returns the label, customs, and other printable documents
+    # associated with a previously-purchased shipment.
+    # @param [String] shipment_id Required parameter: Identifier of the shipment
+    # whose documents to retrieve.
+    # @param [String] package_client_reference_id Optional parameter: Optional
+    # package-level reference id to retrieve documents for a specific package
+    # within a multi-package shipment.
+    # @param [Format1] format Optional parameter: Requested document format
+    # (defaults to PDF).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_shipment_documents(shipment_id,
+                               package_client_reference_id: nil,
+                               format: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipping/v4/shipments/{shipmentId}/documents',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(shipment_id, key: 'shipmentId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(package_client_reference_id, key: 'packageClientReferenceId'))
+                   .query_param(new_parameter(format, key: 'format'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetShipmentDocumentsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Cancels a shipment that has not yet shipped. Cancellation
+    # eligibility is carrier-dependent; refer to the response
+    # cancellation status to confirm.
+    # @param [String] shipment_id Required parameter: Identifier of the shipment
+    # to cancel.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def cancel_shipment(shipment_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/shipping/v4/shipments/{shipmentId}/cancel',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(shipment_id, key: 'shipmentId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CancelShipmentResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Returns access points (pickup and dropoff locations) near the
+    # supplied postal code and country, optionally filtered by access
+    # point type.
+    # @param [String] access_point_types Required parameter: Comma-separated
+    # list of access point types to include.
+    # @param [String] country_code Required parameter: ISO 3166-1 alpha-2
+    # country code (e.g. US, CA, MX).
+    # @param [String] postal_code Required parameter: Postal code to search
+    # around.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_access_points(access_point_types,
+                          country_code,
+                          postal_code)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipping/v4/accessPoints',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(access_point_types, key: 'accessPointTypes')
+                                 .is_required(true))
+                   .query_param(new_parameter(country_code, key: 'countryCode')
+                                 .is_required(true))
+                   .query_param(new_parameter(postal_code, key: 'postalCode')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetAccessPointsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Submits seller feedback on a non-delivery event for a shipment,
+    # instructing the carrier on how to proceed (return, reattempt,
+    # redirect, etc).
+    # @param [SubmitNdrFeedbackRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def submit_ndr_feedback(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/shipping/v4/ndrFeedback',
+                                     Server::DEFAULT1)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Returns a JSON Schema document describing any
+    # carrier-and-service-specific inputs required to purchase a
+    # shipment for the supplied requestToken + rateId. The schema is
+    # served verbatim and the calling client should validate the
+    # seller's input against it before issuing purchaseShipment.
+    # @param [String] rate_id Required parameter: rateId returned by a prior
+    # getRates response.
+    # @param [String] request_token Required parameter: requestToken returned by
+    # a prior getRates response.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_additional_inputs(rate_id,
+                              request_token)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipping/v4/shipments/additionalInputs/schema',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(rate_id, key: 'rateId')
+                                 .is_required(true))
+                   .query_param(new_parameter(request_token, key: 'requestToken')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetAdditionalInputsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+  end
+end

data/lib/walmart_ap_is/apis/solicitations_api.rb

@@ -0,0 +1,92 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # SolicitationsApi
+  class SolicitationsApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] sp_api_order_id Required parameter: An SP-API order
+    # identifier. This specifies the order for which you want a list of
+    # available solicitation types.
+    # @param [Array[String]] marketplace_ids Required parameter: A marketplace
+    # identifier. This specifies the marketplace in which the order was placed.
+    # Only one marketplace can be spec
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_solicitation_actions_for_order(sp_api_order_id,
+                                           marketplace_ids)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/solicitations/v4/orders/{sp-apiOrderId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(sp_api_order_id, key: 'sp-apiOrderId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(marketplace_ids, key: 'marketplaceIds')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] sp_api_order_id Required parameter: An SP-API order
+    # identifier. This specifies the order for which a solicitation is sent.
+    # @param [Array[String]] marketplace_ids Required parameter: A marketplace
+    # identifier. This specifies the marketplace in which the order was placed.
+    # Only one marketplace can be spec
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_product_review_and_seller_feedback_solicitation(sp_api_order_id,
+                                                               marketplace_ids)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/solicitations/v4/orders/{sp-apiOrderId}/solicitations/productReviewAndSellerFeedback',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(sp_api_order_id, key: 'sp-apiOrderId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(marketplace_ids, key: 'marketplaceIds')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+  end
+end

data/lib/walmart_ap_is/apis/uploads_api.rb

@@ -0,0 +1,59 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # UploadsApi
+  class UploadsApi < BaseApi
+    # Returns a pre-signed URL and upload destination ID for uploading
+    # a document for the given resource (e.g. feeds, reports).
+    # **Do not log the pre-signed URL — it contains temporary credentials.**
+    # @param [Resource] resource Required parameter: The resource type for the
+    # upload destination (e.g. feeds)
+    # @param [String] content_md5 Required parameter: MD5 hash of the content to
+    # be uploaded, encoded as base64
+    # @param [ContentType1] content_type Required parameter: MIME type of the
+    # content to be uploaded
+    # @param [Array[MarketplaceId]] marketplace_ids Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_upload_destination_for_resource(resource,
+                                               content_md5,
+                                               content_type,
+                                               marketplace_ids)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/uploads/v4/uploadDestinations/{resource}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(resource, key: 'resource')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(content_md5, key: 'contentMD5')
+                                  .is_required(true))
+                   .query_param(new_parameter(content_type, key: 'contentType')
+                                 .is_required(true))
+                   .query_param(new_parameter(marketplace_ids, key: 'marketplaceIds')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CreateUploadDestinationResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+  end
+end