walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/apis/product_type_definitions_api.rb

@@ -0,0 +1,89 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ProductTypeDefinitionsApi
+  class ProductTypeDefinitionsApi < BaseApi
+    # **Placeholder — not yet implemented.**
+    # @param [String] keywords Optional parameter: TODO: type description here
+    # @param [String] item_name Optional parameter: TODO: type description
+    # here
+    # @param [String] locale Optional parameter: Example:en_US
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_product_type_definitions(keywords: nil,
+                                        item_name: nil,
+                                        locale: 'en_US')
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/definitions/v4/productTypes',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(keywords, key: 'keywords'))
+                   .query_param(new_parameter(item_name, key: 'itemName'))
+                   .query_param(new_parameter(locale, key: 'locale'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ProductTypeList.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
+
+    # **Placeholder — not yet implemented.**
+    # @param [String] product_type Required parameter: TODO: type description
+    # here
+    # @param [String] seller_id Optional parameter: TODO: type description
+    # here
+    # @param [String] locale Optional parameter: Example:en_US
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_product_type_definition(product_type,
+                                    seller_id: nil,
+                                    locale: 'en_US')
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/definitions/v4/productTypes/{productType}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(product_type, key: 'productType')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(seller_id, key: 'sellerId'))
+                   .query_param(new_parameter(locale, key: 'locale'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ProductTypeDefinition.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/reconciliation_api.rb

@@ -0,0 +1,109 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ReconciliationApi
+  class ReconciliationApi < BaseApi
+    # Downloads a reconciliation report ZIP for the given partner and date.
+    # Delegates to mp-payment-reporting GET /v1/mt/report/reconreport/reconFile
+    # (Azure MT storage).
+    # @param [String] partner_id Required parameter: Numeric partner/seller ID
+    # @param [String] report_date Required parameter: Report date in MMddyyyy
+    # format (e.g. 06172026)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def download_reconciliation_report(partner_id,
+                                       report_date)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/disbursements/v4/payment/reconciliation/download',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(partner_id, key: 'partnerId')
+                                 .is_required(true))
+                   .query_param(new_parameter(report_date, key: 'reportDate')
+                                 .is_required(true))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .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
+
+    # Returns the set of available reconciliation report dates for a partner.
+    # Delegates to mp-payment-reporting GET
+    # /v3/report/reconreport/availableReconFiles.
+    # @param [String] partner_id Required parameter: Numeric partner/seller ID
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_reconciliation_dates(partner_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/disbursements/v4/payment/reconciliation/dateList',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(partner_id, key: 'partnerId')
+                                 .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(ReportAvailabilityResponse.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
+
+    # Checks which reconciliation report versions (legacy, v1/WFS) are available
+    # for a given partner and date. Delegates to mp-payment-reporting
+    # GET /v3/report/reconreport/reconReportAvailability.
+    # Note: the upstream date param is named `date` (not `reportDate`).
+    # @param [String] partner_id Required parameter: Numeric partner/seller ID
+    # @param [Date] date Required parameter: Report date in yyyy-MM-dd format
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def check_download_report_by_period(partner_id,
+                                        date)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/disbursements/v4/payment/checkDownloadReportByPeriod',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(partner_id, key: 'partnerId')
+                                 .is_required(true))
+                   .query_param(new_parameter(date, key: 'date')
+                                 .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(ReportAvailabilityResponse.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

data/lib/walmart_ap_is/apis/report_schedules_api.rb

@@ -0,0 +1,148 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ReportSchedulesApi
+  class ReportSchedulesApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Array[ReportType1]] report_types Optional parameter: Filter by
+    # report type. Values are Walmart Partner Reporting Platform enum names.
+    # Runtime availability is CCM-controlled; consult PRP docs for current
+    # PROD-enabled types.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_report_schedules(report_types: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/v4/schedules',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(report_types, key: 'reportTypes'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetReportSchedulesResponse.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
+
+    # TODO: type endpoint description here
+    # @param [CreateReportScheduleSpecification] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_report_schedule(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/reports/v4/schedules',
+                                     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(CreateReportScheduleResponse.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
+
+    # TODO: type endpoint description here
+    # @param [String] report_schedule_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_report_schedule(report_schedule_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/v4/schedules/{reportScheduleId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(report_schedule_id, key: 'reportScheduleId')
+                                    .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(ReportSchedule.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
+
+    # TODO: type endpoint description here
+    # @param [String] report_schedule_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def cancel_report_schedule(report_schedule_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/reports/v4/schedules/{reportScheduleId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(report_schedule_id, key: 'reportScheduleId')
+                                    .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(CancelReportScheduleResponse.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/reports_api.rb

@@ -0,0 +1,269 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ReportsApi
+  class ReportsApi < BaseApi
+    # Downloads the current-format settlement summary report ZIP.
+    # Delegates to mp-payment-reporting GET /v3/report/reconreport/v1/reconFile
+    # (Swift v1 storage).
+    # @param [String] partner_id Required parameter: Numeric partner/seller ID
+    # @param [String] report_date Required parameter: Report date in MMddyyyy
+    # format (e.g. 06172026)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def download_new_report(partner_id,
+                            report_date)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/disbursements/v4/payment/summary/newReportDownload',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(partner_id, key: 'partnerId')
+                                 .is_required(true))
+                   .query_param(new_parameter(report_date, key: 'reportDate')
+                                 .is_required(true))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .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
+
+    # Downloads the legacy-format settlement summary report ZIP.
+    # Delegates to mp-payment-reporting GET /v3/report/reconreport/reconFile
+    # (legacy Swift storage).
+    # @param [String] partner_id Required parameter: Numeric partner/seller ID
+    # @param [String] report_date Required parameter: Report date in MMddyyyy
+    # format (e.g. 06172026)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def download_old_report(partner_id,
+                            report_date)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/disbursements/v4/payment/summary/oldReportDownload',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(partner_id, key: 'partnerId')
+                                 .is_required(true))
+                   .query_param(new_parameter(report_date, key: 'reportDate')
+                                 .is_required(true))
+                   .auth(Single.new('walletAuth')))
+        .response(new_response_handler
+                    .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
+
+    # TODO: type endpoint description here
+    # @param [Array[ReportType1]] report_types Optional parameter: Filter by
+    # report type. Values are Walmart Partner Reporting Platform enum names.
+    # Runtime availability is CCM-controlled; consult PRP docs for current
+    # PROD-enabled types.
+    # @param [Array[ProcessingStatus]] processing_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_reports(report_types: nil,
+                    processing_statuses: nil,
+                    created_since: nil,
+                    created_until: nil,
+                    page_size: 10,
+                    next_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/v4/reports',
+                                     Server::DEFAULT1)
+                   .query_param(new_parameter(report_types, key: 'reportTypes'))
+                   .query_param(new_parameter(processing_statuses, key: 'processingStatuses'))
+                   .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(GetReportsResponse.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
+
+    # Submits a report request. Poll `GET /reports/{reportId}` for status.
+    # Report type taxonomy TBD — coordinate with Pod 5 for financial reports.
+    # @param [CreateReportSpecification] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_report(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/reports/v4/reports',
+                                     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(CreateReportResponse.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
+
+    # TODO: type endpoint description here
+    # @param [String] report_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_report(report_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/v4/reports/{reportId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(report_id, key: 'reportId')
+                                    .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(Report.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
+
+    # TODO: type endpoint description here
+    # @param [String] report_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def cancel_report(report_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/reports/v4/reports/{reportId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(report_id, key: 'reportId')
+                                    .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(CancelReportResponse.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 a pre-signed URL for downloading the completed report.
+    # Do not log the pre-signed URL.
+    # @param [String] report_document_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_report_document(report_document_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reports/v4/documents/{reportDocumentId}',
+                                     Server::DEFAULT1)
+                   .template_param(new_parameter(report_document_id, key: 'reportDocumentId')
+                                    .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(ReportDocument.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