walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/apis/sales_api.rb

@@ -0,0 +1,117 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # SalesApi
+  class SalesApi < BaseApi
+    # TODO: type endpoint description here
+    # @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 specified
+    # @param [String] interval Required parameter: A time interval used for
+    # selecting order metrics. This takes the form of two dates separated by two
+    # hyphens (first date is inclusive; second date is exclusive). Dates are in
+    # ISO8601 format and must represent absolute time (either Z notation or
+    # offset notation). Example:
+    # 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order
+    # metrics for Sept 1st, 2nd and 3rd in the -07:00 zone.
+    # @param [Granularity] granularity Required parameter: The granularity of
+    # the grouping of order metrics, based on a unit of time. Specifying
+    # granularity=Hour results in a successful request only if the interval
+    # specified is less than or equal to 30 days from now. For all other
+    # granularities, the interval specified must be less or equal to 2 years
+    # from now. Specifying granularity=Total results in order metrics that are
+    # aggregated over the entire interval that you specify. If the interval
+    # start and end date don’t align with the specified granularity, the head
+    # and tail end of the response interval will contain partial data. Example:
+    # Day to get a daily breakdown of the request interval, where the day
+    # boundary is defined by the granularityTimeZone.
+    # @param [String] granularity_time_zone Optional parameter: An
+    # IANA-compatible time zone for determining the day boundary. Required when
+    # specifying a granularity value greater than Hour. The granularityTimeZone
+    # value must align with the offset of the specified interval value. For
+    # example, if the interval value uses Z notation, then granularityTimeZone
+    # must be UTC. If the interval value uses an offset, then
+    # granularityTimeZone must be an IANA-compatible time zone that matches the
+    # offset. Example: US/Pacific to compute day boundaries, accounting for
+    # daylight time savings, for US/Pacific zone.
+    # @param [BuyerType] buyer_type Optional parameter: Filters the results by
+    # the buyer type that you specify, B2B (business to business) or B2C
+    # (business to customer). Example: B2B, if you want the response to include
+    # order metrics for only B2B buyers.
+    # @param [String] fulfillment_network Optional parameter: Filters the
+    # results by the fulfillment network that you specify, MFN (merchant
+    # fulfillment network) or AFN (marketplace fulfillment network). Do not
+    # include this filter if you want the response to include order metrics for
+    # all fulfillment networks. Example: AFN, if you want the response to
+    # include order metrics for only the marketplace fulfillment network.
+    # @param [FirstDayOfWeek] first_day_of_week Optional parameter: Specifies
+    # the day that the week starts on when granularity=Week, either Monday or
+    # Sunday. Default: Monday. Example: Sund
+    # @param [String] asin Optional parameter: Filters the results by the ASIN
+    # that you specify. Specifying both ASIN and SKU returns an error. Do not
+    # include this filter if you want the response to include order metrics for
+    # all ASINs. Example: B0792R1RSN, if you want the response to include order
+    # metrics for only ASIN B0792R1RSN.
+    # @param [String] sku Optional parameter: Filters the results by the SKU
+    # that you specify. Specifying both ASIN and SKU returns an error. Do not
+    # include this filter if you want the response to include order metrics for
+    # all SKUs. Example: TestSKU, if you want the response to include order
+    # metrics for only SKU TestSKU.
+    # @param [String] sp_api_program Optional parameter: Filters the results by
+    # the program that you specify. Do not include this filter if you want the
+    # response to inclu
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_order_metrics(marketplace_ids,
+                          interval,
+                          granularity,
+                          granularity_time_zone: nil,
+                          buyer_type: nil,
+                          fulfillment_network: nil,
+                          first_day_of_week: nil,
+                          asin: nil,
+                          sku: nil,
+                          sp_api_program: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/sales/v4/orderMetrics',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(marketplace_ids, key: 'marketplaceIds')
+                                 .is_required(true))
+                   .query_param(new_parameter(interval, key: 'interval')
+                                 .is_required(true))
+                   .query_param(new_parameter(granularity, key: 'granularity')
+                                 .is_required(true))
+                   .query_param(new_parameter(granularity_time_zone, key: 'granularityTimeZone'))
+                   .query_param(new_parameter(buyer_type, key: 'buyerType'))
+                   .query_param(new_parameter(fulfillment_network, key: 'fulfillmentNetwork'))
+                   .query_param(new_parameter(first_day_of_week, key: 'firstDayOfWeek'))
+                   .query_param(new_parameter(asin, key: 'asin'))
+                   .query_param(new_parameter(sku, key: 'sku'))
+                   .query_param(new_parameter(sp_api_program, key: 'sp-apiProgram'))
+                   .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/sellers_api.rb

@@ -0,0 +1,67 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # SellersApi
+  class SellersApi < BaseApi
+    # Returns the list of marketplaces the authenticated seller participates in
+    # (e.g. Walmart US, Walmart Canada, Walmart Mexico).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_marketplace_participations
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/sellers/v4/marketplaceParticipations',
+                                     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(GetMarketplaceParticipationsResponse.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
+
+    # Returns the authenticated seller's account information including
+    # business name, email, account status, and seller type.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_seller_account
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/sellers/v4/account',
+                                     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(SellerAccount.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

data/lib/walmart_ap_is/apis/settlement_api.rb

@@ -0,0 +1,140 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # SettlementApi
+  class SettlementApi < BaseApi
+    # Returns available settlement period dates for the authenticated seller.
+    # Delegates to mp-payment-reporting GET
+    # /v3/report/reconreport/v1/availableReconFiles.
+    # @param [Integer] page_size Optional parameter: Example:10
+    # @param [String] next_token Optional parameter: Opaque cursor from a prior
+    # response; omit for first page
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_settlement_periods(page_size: 10,
+                                next_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/disbursements/v4/payment/settlementPeriods',
+                                     Server::DEFAULT1)
+                   .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(SettlementPeriodsResponse.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('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Returns paginated settlement transaction detail for the given partner and
+    # report date.
+    # Contains PII (purchase order IDs). Delegates to mp-payment-reporting
+    # GET /v3/report/reconreport/v1/getJson with offset-based pagination.
+    # nextToken is a Base64-encoded offset into the report file.
+    # @param [String] partner_id Required parameter: Numeric partner/seller ID
+    # @param [String] report_date Required parameter: Report date in MMddyyyy
+    # format (e.g. 06172026)
+    # @param [Integer] page_size Optional parameter: Example:10
+    # @param [String] next_token Optional parameter: Opaque cursor from a prior
+    # response; omit for first page
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_settlement_details(partner_id,
+                                report_date,
+                                page_size: 10,
+                                next_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/disbursements/v4/payment/settlementDetails',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(partner_id, key: 'partnerId')
+                                 .is_required(true))
+                   .query_param(new_parameter(report_date, key: 'reportDate')
+                                 .is_required(true))
+                   .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(SettlementDetailsResponse.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('403',
+                                 'Forbidden',
+                                 ErrorListErrorException)
+                    .local_error('429',
+                                 'Rate limit exceeded',
+                                 ErrorListErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+
+    # Returns a paginated list of payment transactions for the authenticated
+    # seller
+    # filtered by optional date range. Contains PII (purchase order IDs).
+    # Delegates to GMPPaymentsPlatform (Phase 5).
+    # @param [Integer] page_size Optional parameter: Example:10
+    # @param [String] next_token Optional parameter: Opaque cursor from a prior
+    # response; omit for first page
+    # @param [DateTime] posted_after Optional parameter: TODO: type description
+    # here
+    # @param [DateTime] posted_before Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_transactions(page_size: 10,
+                            next_token: nil,
+                            posted_after: nil,
+                            posted_before: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/disbursements/v4/payment/search/transactions',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(page_size, key: 'pageSize'))
+                   .query_param(new_parameter(next_token, key: 'nextToken'))
+                   .query_param(new_parameter(posted_after, key: 'postedAfter'))
+                   .query_param(new_parameter(posted_before, key: 'postedBefore'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransactionSearchResponse.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('500',
+                                 'Internal Server Error',
+                                 ErrorListErrorException))
+        .execute
+    end
+  end
+end