walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/apis/feeds_api.rb

@@ -1,79 +1,181 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
-module WalmartApIs
-  # FeedsApi
-  class FeedsApi < BaseApi
-    # Updates prices in bulk.
-    # In one Feed you can update up to 10,000 items in bulk. To ensure optimal
-    # Feed processing time, we recommend sending no more than 1000 items in one
-    # Feed and keeping the Feed sizes below 10 MB.
-    # The price sequence guarantee is observed by the bulk price update
-    # functionality, subject to the following rules:
-    # The timestamp used to determine precedence is passed in the request
-    # headers. All price updates in the feed are considered to have the same
-    # timestamp. The timestamp in the XML file is used only for auditing.
-    # You can send a single SKU multiple times in one Feed. If a SKU is repeated
-    # in a Feed, the price will be set for that SKU on Walmart.com, but there is
-    # no guarantee as to which SKU's price within that feed will be used.
-    # This API should be used in preference to the update a price. It should be
-    # called no sooner than 24 hours after a new item is set up and a wpid
-    # (Walmart Part ID) is available. Thereafter, the bulk price update has an
-    # service level agreement (SLA) of 15 minutes.
-    # After the update is submitted, wait for at least five minutes before
-    # verifying whether the bulk price update was successful. Individual SKU
-    # price update success or failure is only available after the entire feed is
-    # processed.
-    # If a SKU's price update fails (for example, multiple price updates were
-    # sent for the same SKU in a single feed), an error will be returned.
-    # <b>You can download the request body sample from <a
-    # href="/file/mp/us/price-feed.zip">here</a></b>
-    # @param [String] feed_type Required parameter: The feed Type
-    # @param [String] wm_sec_access_token Required parameter: The access token
-    # retrieved in the Token API call
-    # @param [String] wm_consumer_channel_type Required parameter: A unique ID
-    # to track the consumer request by channel. Use the Consumer Channel Type
-    # received during onboarding
-    # @param [String] wm_qos_correlation_id Required parameter: A unique ID
-    # which identifies each API call and used to track and debug issues; use a
-    # random generated GUID for this ID
-    # @param [String] wm_svc_name Required parameter: Walmart Service Name
-    # @param [String] accept Required parameter: TODO: type description here
-    # @param [File | UploadIO] file Required parameter: Feed file to upload
-    # @return [ApiResponse] Complete http response with raw body and status code.
-    def update_bulk_prices_legacy(feed_type,
-                                  wm_sec_access_token,
-                                  wm_consumer_channel_type,
-                                  wm_qos_correlation_id,
-                                  wm_svc_name,
-                                  accept,
-                                  file)
-      @api_call
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/feeds',
-                                     Server::SERVER_1)
-                   .query_param(new_parameter(feed_type, key: 'feedType')
-                                 .is_required(true))
-                   .header_param(new_parameter(wm_sec_access_token, key: 'WM_SEC.ACCESS_TOKEN')
-                                  .is_required(true))
-                   .header_param(new_parameter(wm_consumer_channel_type, key: 'WM_CONSUMER.CHANNEL.TYPE')
-                                  .is_required(true))
-                   .header_param(new_parameter(wm_qos_correlation_id, key: 'WM_QOS.CORRELATION_ID')
-                                  .is_required(true))
-                   .header_param(new_parameter(wm_svc_name, key: 'WM_SVC.NAME')
-                                  .is_required(true))
-                   .header_param(new_parameter(accept, key: 'Accept')
-                                  .is_required(true))
-                   .multipart_param(new_parameter(file, key: 'file')
-                                     .is_required(true)
-                                     .default_content_type('application/octet-stream')))
-        .response(new_response_handler
-                    .deserializer(APIHelper.method(:custom_type_deserializer))
-                    .deserialize_into(Json1.method(:from_hash))
-                    .is_api_response(true))
-        .execute
-    end
-  end
-end
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FeedsApi
+  class FeedsApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Array[FeedType]] feed_types Optional parameter: Feed type filter
+    # @param [Array[FeedStatus]] feed_statuses Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] created_since Optional parameter: TODO: type description
+    # here
+    # @param [DateTime] created_until Optional parameter: TODO: type description
+    # here
+    # @param [Integer] page_size Optional parameter: Example:10
+    # @param [String] next_token Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_feeds(feed_types: nil,
+                  feed_statuses: nil,
+                  created_since: nil,
+                  created_until: nil,
+                  page_size: 10,
+                  next_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/feeds/v4/feeds',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(feed_types, key: 'feedTypes'))
+                   .query_param(new_parameter(feed_statuses, key: 'feedStatuses'))
+                   .query_param(new_parameter(created_since, key: 'createdSince'))
+                   .query_param(new_parameter(created_until, key: 'createdUntil'))
+                   .query_param(new_parameter(page_size, key: 'pageSize'))
+                   .query_param(new_parameter(next_token, key: 'nextToken'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetFeedsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListError1Exception)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListError1Exception)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListError1Exception)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListError1Exception))
+        .execute
+    end
+
+    # Upload a feed file and submit it for asynchronous processing in a single
+    # call.
+    # The server handles document storage internally. Use the returned feedId to
+    # poll
+    # processing status via GET /feeds/v4/feeds/{feedId}.
+    # @param [FeedType] feed_type Required parameter: The type of feed being
+    # submitted
+    # @param [File | UploadIO] file Required parameter: The feed content file to
+    # upload and process
+    # @param [String] marketplace_id Optional parameter: Marketplace identifier.
+    # Defaults to WALMART_US.
+    # @param [ContentType] content_type Optional parameter: MIME type of the
+    # uploaded feed content. If omitted, the server infers from the file's
+    # Content-Type in the multipart header.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_feed(feed_type,
+                    file,
+                    marketplace_id: 'WALMART_US',
+                    content_type: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/feeds/v4/feeds',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(feed_type, key: 'feedType')
+                                 .is_required(true))
+                   .multipart_param(new_parameter(file, key: 'file')
+                                     .is_required(true)
+                                     .default_content_type('application/octet-stream'))
+                   .query_param(new_parameter(marketplace_id, key: 'marketplaceId'))
+                   .form_param(new_parameter(content_type, key: 'contentType'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CreateFeedResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListError1Exception)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListError1Exception)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListError1Exception)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListError1Exception))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] feed_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_feed(feed_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/feeds/v4/feeds/{feedId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(feed_id, key: 'feedId')
+                                    .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(Feed.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListError1Exception)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListError1Exception)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListError1Exception)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListError1Exception)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListError1Exception))
+        .execute
+    end
+
+    # Downloads the raw feed document file. The response is a binary stream
+    # (application/octet-stream). The Content-Disposition header contains the
+    # original filename when available. Content-Length header is always set
+    # to enable download progress tracking.
+    # An IDOR check is performed before the download — the authenticated
+    # seller must own the feed referenced by feedId.
+    # @param [String] feed_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_feed_document(feed_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/feeds/v4/feeds/{feedId}/document',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(feed_id, key: 'feedId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListError1Exception)
+                    .local_error('403',
+                                 'Forbidden',
+                                 ErrorListError1Exception)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListError1Exception)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListError1Exception)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListError1Exception))
+        .execute
+    end
+  end
+end

data/lib/walmart_ap_is/apis/fees_api.rb

@@ -0,0 +1,127 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FeesApi
+  class FeesApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Object] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_my_fees_estimates(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/products/fees/v4/feesEstimate',
+                                     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(APIHelper.method(:json_serialize))
+                   .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] asin Required parameter: The SP-API Standard
+    # Identification Number (ASIN) of the item.
+    # @param [Object] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_my_fees_estimate_for_asin(asin,
+                                      body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/products/fees/v4/items/{Asin}/feesEstimate',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(asin, key: 'Asin')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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(APIHelper.method(:json_serialize))
+                   .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] seller_sku Required parameter: Used to identify an item in
+    # the given marketplace. SellerSKU is qualified by the seller's SellerId,
+    # which is included wi
+    # @param [Object] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_my_fees_estimate_for_sku(seller_sku,
+                                     body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/products/fees/v4/listings/{SellerSKU}/feesEstimate',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(seller_sku, key: 'SellerSKU')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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(APIHelper.method(:json_serialize))
+                   .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/final_payout_api.rb

@@ -0,0 +1,75 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FinalPayoutApi
+  class FinalPayoutApi < BaseApi
+    # Returns the current state, case ID, and payable amount for the
+    # authenticated
+    # seller's final payout case (used when a seller account is being
+    # offboarded).
+    # Delegates to GMPPaymentsPlatform (Phase 5).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_final_payout_case_status
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/disbursements/v4/finalPayout/case/status',
+                                     Server::DEFAULT1)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FinalPayoutCaseStatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('401',
+                                 'Unauthorized — missing, expired, or invalid OAuth2 token',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Transitions the authenticated seller's final payout case to Resolved or
+    # Closed, optionally including resolution notes. Requires
+    # "disbursements:write"
+    # scope. Delegates to GMPPaymentsPlatform (Phase 5).
+    # @param [DisbursementsV4FinalPayoutCaseUpdateStatusRequest] body Required
+    # parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_final_payout_case_status(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/disbursements/v4/finalPayout/case/updateStatus',
+                                     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(FinalPayoutCaseStatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ErrorListErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+  end
+end