growwer 1.0.0

data/lib/growwer/api/seller_money_api.rb

@@ -0,0 +1,358 @@
+=begin
+#Growwer API
+
+#The Growwer customer API. Authenticate every call with an API key created on your profile page, sent as `Authorization: Bearer <key>`. A read key can call every GET operation; writes need a read and write key and an `Idempotency-Key` header.  Idempotency: use a new `Idempotency-Key` (1 to 255 printable ASCII characters without spaces) for each operation and reuse it only to retry that same operation. Keys belong to your account, not to one API key. - A successful write is stored for 30 days: a retry with the same key and   the same request replays its response with `Idempotent-Replayed: true`   and does nothing again. - A refused write (4xx) has no effect and releases its key: once you fix the   cause, retry with the same key and the write runs. - A failed write (5xx) may have taken effect, so it is never run again under   its key: a retry gets 409 `idempotency_outcome_unknown`. Check whether it   took effect before retrying with a new key. - A retry while the first request is still running gets 409   `idempotency_request_in_progress`. A request still running after 5 minutes   is treated as failed: a retry gets 409 `idempotency_outcome_unknown`. - The same key with a different request (method, path, query or body) gets   409 `idempotency_key_reused`. A write without the header gets 400   `idempotency_key_required`.  Every response carries `X-Request-Id`. Errors share one shape, `{code, message, requestId, details?}`. Money is integer cents plus a currency code and dates are ISO-8601. 
+
+The version of the OpenAPI document: 1
+Contact: support@growwer.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module Growwer
+  class SellerMoneyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Download the document of a seller wallet movement
+    # The document Growwer attached to a movement of your seller wallet. 404 when the movement has none (`hasDocument` is false) or the file cannot be read.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def download_seller_transaction_document(id, opts = {})
+      data, _status_code, _headers = download_seller_transaction_document_with_http_info(id, opts)
+      data
+    end
+
+    # Download the document of a seller wallet movement
+    # The document Growwer attached to a movement of your seller wallet. 404 when the movement has none (&#x60;hasDocument&#x60; is false) or the file cannot be read.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def download_seller_transaction_document_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SellerMoneyApi.download_seller_transaction_document ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SellerMoneyApi.download_seller_transaction_document"
+      end
+      # resource path
+      local_var_path = '/api/v1/wallets/seller/transactions/{id}/document'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"SellerMoneyApi.download_seller_transaction_document",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SellerMoneyApi#download_seller_transaction_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download the invoice of a withdrawal
+    # The invoice you uploaded for one of your withdrawals, named `withdrawal-{id}-invoice.pdf`. 404 when the withdrawal has none (`hasInvoice` is false); 503 `storage_unavailable` when the file cannot be read right now.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def download_withdrawal_invoice(id, opts = {})
+      data, _status_code, _headers = download_withdrawal_invoice_with_http_info(id, opts)
+      data
+    end
+
+    # Download the invoice of a withdrawal
+    # The invoice you uploaded for one of your withdrawals, named &#x60;withdrawal-{id}-invoice.pdf&#x60;. 404 when the withdrawal has none (&#x60;hasInvoice&#x60; is false); 503 &#x60;storage_unavailable&#x60; when the file cannot be read right now.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def download_withdrawal_invoice_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SellerMoneyApi.download_withdrawal_invoice ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SellerMoneyApi.download_withdrawal_invoice"
+      end
+      # resource path
+      local_var_path = '/api/v1/withdrawals/{id}/invoice'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"SellerMoneyApi.download_withdrawal_invoice",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SellerMoneyApi#download_withdrawal_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get your seller wallet
+    # What your sales have earned: the balance you can withdraw now and what is held until orders settle. `restricted` is true while your seller account is restricted; the reason is not published here, and support can tell you more.
+    # @param [Hash] opts the optional parameters
+    # @return [GetSellerWallet200Response]
+    def get_seller_wallet(opts = {})
+      data, _status_code, _headers = get_seller_wallet_with_http_info(opts)
+      data
+    end
+
+    # Get your seller wallet
+    # What your sales have earned: the balance you can withdraw now and what is held until orders settle. &#x60;restricted&#x60; is true while your seller account is restricted; the reason is not published here, and support can tell you more.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetSellerWallet200Response, Integer, Hash)>] GetSellerWallet200Response data, response status code and response headers
+    def get_seller_wallet_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SellerMoneyApi.get_seller_wallet ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/wallets/seller'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetSellerWallet200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"SellerMoneyApi.get_seller_wallet",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SellerMoneyApi#get_seller_wallet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List your seller wallet movements
+    # Every movement of your seller wallet, newest first: earnings from orders, withdrawals and manual corrections. An earning names its order (`orderId`) and a withdrawal its request (`withdrawalId`).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Movements per page, 1 to 100. (default to 20)
+    # @option opts [Integer] :offset Movements to skip. (default to 0)
+    # @return [ListSellerTransactions200Response]
+    def list_seller_transactions(opts = {})
+      data, _status_code, _headers = list_seller_transactions_with_http_info(opts)
+      data
+    end
+
+    # List your seller wallet movements
+    # Every movement of your seller wallet, newest first: earnings from orders, withdrawals and manual corrections. An earning names its order (&#x60;orderId&#x60;) and a withdrawal its request (&#x60;withdrawalId&#x60;).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Movements per page, 1 to 100. (default to 20)
+    # @option opts [Integer] :offset Movements to skip. (default to 0)
+    # @return [Array<(ListSellerTransactions200Response, Integer, Hash)>] ListSellerTransactions200Response data, response status code and response headers
+    def list_seller_transactions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SellerMoneyApi.list_seller_transactions ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SellerMoneyApi.list_seller_transactions, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SellerMoneyApi.list_seller_transactions, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling SellerMoneyApi.list_seller_transactions, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/wallets/seller/transactions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListSellerTransactions200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"SellerMoneyApi.list_seller_transactions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SellerMoneyApi#list_seller_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List your withdrawals
+    # The withdrawals you requested from your seller wallet, newest first. Requesting a withdrawal is not available through the API; use the seller wallet page.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :state Only the withdrawals in one of these states, comma-separated: &#x60;started&#x60;, &#x60;approved&#x60;, &#x60;rejected&#x60;. An unknown state is refused with 422.
+    # @option opts [Integer] :limit Withdrawals per page, 1 to 100. (default to 20)
+    # @option opts [Integer] :offset Withdrawals to skip. (default to 0)
+    # @return [ListWithdrawals200Response]
+    def list_withdrawals(opts = {})
+      data, _status_code, _headers = list_withdrawals_with_http_info(opts)
+      data
+    end
+
+    # List your withdrawals
+    # The withdrawals you requested from your seller wallet, newest first. Requesting a withdrawal is not available through the API; use the seller wallet page.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :state Only the withdrawals in one of these states, comma-separated: &#x60;started&#x60;, &#x60;approved&#x60;, &#x60;rejected&#x60;. An unknown state is refused with 422.
+    # @option opts [Integer] :limit Withdrawals per page, 1 to 100. (default to 20)
+    # @option opts [Integer] :offset Withdrawals to skip. (default to 0)
+    # @return [Array<(ListWithdrawals200Response, Integer, Hash)>] ListWithdrawals200Response data, response status code and response headers
+    def list_withdrawals_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SellerMoneyApi.list_withdrawals ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SellerMoneyApi.list_withdrawals, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SellerMoneyApi.list_withdrawals, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling SellerMoneyApi.list_withdrawals, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/withdrawals'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListWithdrawals200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"SellerMoneyApi.list_withdrawals",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SellerMoneyApi#list_withdrawals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end