payzu-pix 2.0.0

data/docs/WithdrawalsApi.md

@@ -0,0 +1,299 @@
+# PayZuPix::WithdrawalsApi
+
+All URIs are relative to *https://api.payzu.processamento.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_withdraw**](WithdrawalsApi.md#get_withdraw) | **GET** /withdraw | Retrieve Withdrawal |
+| [**get_withdraw_proof**](WithdrawalsApi.md#get_withdraw_proof) | **GET** /withdraw/proof/{id} | Get Withdrawal Receipt |
+| [**post_withdraw**](WithdrawalsApi.md#post_withdraw) | **POST** /withdraw | Create Withdrawal (Pix key) |
+| [**post_withdraw_qrcode**](WithdrawalsApi.md#post_withdraw_qrcode) | **POST** /withdraw/qrcode | Create Withdrawal using QR Code |
+
+
+## get_withdraw
+
+> <Transaction> get_withdraw(opts)
+
+Retrieve Withdrawal
+
+Get the latest status and details of a transaction of the account. Provide at least one of `id`, `clientReference`, or `endToEndId`. If more than one is provided, all are applied as filters (AND), which may return no record if they do not point to the same transaction.  Token permission: `WITHDRAW`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'payzu-pix'
+# setup authorization
+PayZuPix.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PayZuPix::WithdrawalsApi.new
+opts = {
+  id: 'PAYZU20260817B3PL8SG5WQ000000', # String | Transaction ID.
+  client_reference: 'order_12345', # String | External reference provided when creating the withdrawal.
+  end_to_end_id: 'E00000000202508172159kZ8dQ2mNb1x', # String | Pix end-to-end ID.
+  virtual_account: 'loja-centro-01' # String | Virtual sub-account (up to 50 characters) used at creation. Accepted as an alternative lookup key.
+}
+
+begin
+  # Retrieve Withdrawal
+  result = api_instance.get_withdraw(opts)
+  p result
+rescue PayZuPix::ApiError => e
+  puts "Error when calling WithdrawalsApi->get_withdraw: #{e}"
+end
+```
+
+#### Using the get_withdraw_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Transaction>, Integer, Hash)> get_withdraw_with_http_info(opts)
+
+```ruby
+begin
+  # Retrieve Withdrawal
+  data, status_code, headers = api_instance.get_withdraw_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Transaction>
+rescue PayZuPix::ApiError => e
+  puts "Error when calling WithdrawalsApi->get_withdraw_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Transaction ID. | [optional] |
+| **client_reference** | **String** | External reference provided when creating the withdrawal. | [optional] |
+| **end_to_end_id** | **String** | Pix end-to-end ID. | [optional] |
+| **virtual_account** | **String** | Virtual sub-account (up to 50 characters) used at creation. Accepted as an alternative lookup key. | [optional] |
+
+### Return type
+
+[**Transaction**](Transaction.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_withdraw_proof
+
+> <ProofResponse> get_withdraw_proof(id, opts)
+
+Get Withdrawal Receipt
+
+Returns the transaction receipt. By default (`type=pdf`) the response is the PDF file; with `type=base64` it is JSON with the `base64` field, the PDF as a data URI.
+
+### Examples
+
+```ruby
+require 'time'
+require 'payzu-pix'
+# setup authorization
+PayZuPix.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PayZuPix::WithdrawalsApi.new
+id = 'PAYZU20260817B3PL8SG5WQ000000' # String | Transaction ID.
+opts = {
+  type: 'pdf' # String | Return format.
+}
+
+begin
+  # Get Withdrawal Receipt
+  result = api_instance.get_withdraw_proof(id, opts)
+  p result
+rescue PayZuPix::ApiError => e
+  puts "Error when calling WithdrawalsApi->get_withdraw_proof: #{e}"
+end
+```
+
+#### Using the get_withdraw_proof_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProofResponse>, Integer, Hash)> get_withdraw_proof_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get Withdrawal Receipt
+  data, status_code, headers = api_instance.get_withdraw_proof_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProofResponse>
+rescue PayZuPix::ApiError => e
+  puts "Error when calling WithdrawalsApi->get_withdraw_proof_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Transaction ID. |  |
+| **type** | **String** | Return format. | [optional][default to &#39;pdf&#39;] |
+
+### Return type
+
+[**ProofResponse**](ProofResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/pdf
+
+
+## post_withdraw
+
+> <Transaction> post_withdraw(post_withdraw_request)
+
+Create Withdrawal (Pix key)
+
+Send a Pix **cash out** to the specified Pix key.  Token permission: `WITHDRAW`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'payzu-pix'
+# setup authorization
+PayZuPix.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PayZuPix::WithdrawalsApi.new
+post_withdraw_request = PayZuPix::PostWithdrawRequest.new({amount: 2, pix_key: 'teste@teste.com', pix_type: 'cpf'}) # PostWithdrawRequest | 
+
+begin
+  # Create Withdrawal (Pix key)
+  result = api_instance.post_withdraw(post_withdraw_request)
+  p result
+rescue PayZuPix::ApiError => e
+  puts "Error when calling WithdrawalsApi->post_withdraw: #{e}"
+end
+```
+
+#### Using the post_withdraw_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Transaction>, Integer, Hash)> post_withdraw_with_http_info(post_withdraw_request)
+
+```ruby
+begin
+  # Create Withdrawal (Pix key)
+  data, status_code, headers = api_instance.post_withdraw_with_http_info(post_withdraw_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Transaction>
+rescue PayZuPix::ApiError => e
+  puts "Error when calling WithdrawalsApi->post_withdraw_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_withdraw_request** | [**PostWithdrawRequest**](PostWithdrawRequest.md) |  |  |
+
+### Return type
+
+[**Transaction**](Transaction.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_withdraw_qrcode
+
+> <Transaction> post_withdraw_qrcode(post_withdraw_qrcode_request)
+
+Create Withdrawal using QR Code
+
+Cash out using a **Pix QR Code** (static/dynamic). If `amount` is not provided, the QR Code's embedded value will be used. PayZu processes both dynamic and static QR Codes.  Token permission: `WITHDRAW`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'payzu-pix'
+# setup authorization
+PayZuPix.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PayZuPix::WithdrawalsApi.new
+post_withdraw_qrcode_request = PayZuPix::PostWithdrawQrcodeRequest.new({qr_code: '00020101021226770014br.gov.bcb.pix2555api.payzu/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916PAYZU 6007SAOPAULO6217051320260118278956304EC55'}) # PostWithdrawQrcodeRequest | 
+
+begin
+  # Create Withdrawal using QR Code
+  result = api_instance.post_withdraw_qrcode(post_withdraw_qrcode_request)
+  p result
+rescue PayZuPix::ApiError => e
+  puts "Error when calling WithdrawalsApi->post_withdraw_qrcode: #{e}"
+end
+```
+
+#### Using the post_withdraw_qrcode_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Transaction>, Integer, Hash)> post_withdraw_qrcode_with_http_info(post_withdraw_qrcode_request)
+
+```ruby
+begin
+  # Create Withdrawal using QR Code
+  data, status_code, headers = api_instance.post_withdraw_qrcode_with_http_info(post_withdraw_qrcode_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Transaction>
+rescue PayZuPix::ApiError => e
+  puts "Error when calling WithdrawalsApi->post_withdraw_qrcode_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_withdraw_qrcode_request** | [**PostWithdrawQrcodeRequest**](PostWithdrawQrcodeRequest.md) |  |  |
+
+### Return type
+
+[**Transaction**](Transaction.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="PayZuAI"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="payzu-sdks"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/payzu-pix/api/account_api.rb

@@ -0,0 +1,136 @@
+=begin
+#PayZu Pix API
+
+#REST API for Pix operations on the PayZu platform, deposits, withdrawals, internal transfers, infractions, reports, and callback inspection. All amounts are in BRL (reais) unless explicitly noted. Authentication uses a Bearer token issued during onboarding.  ## SDKs oficiais  - Node.js: `npm install payzu-pix` - Python: `pip install payzu-pix` - PHP: `composer require payzu/pix` - Ruby: `gem install payzu-pix` - Java: `br.com.payzu:payzu-pix` (Maven Central) - Go: `go get github.com/PayZuAI/payzu-sdks/go/v2`  Repo: https://github.com/PayZuAI/payzu-sdks 
+
+The version of the OpenAPI document: 1.8.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module PayZuPix
+  class AccountApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Account Info
+    # Account profile, permissions, limits and fee rules.
+    # @param [Hash] opts the optional parameters
+    # @return [GetUser200Response]
+    def get_user(opts = {})
+      data, _status_code, _headers = get_user_with_http_info(opts)
+      data
+    end
+
+    # Account Info
+    # Account profile, permissions, limits and fee rules.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetUser200Response, Integer, Hash)>] GetUser200Response data, response status code and response headers
+    def get_user_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.get_user ...'
+      end
+      # resource path
+      local_var_path = '/user'
+
+      # 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] || 'GetUser200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.get_user",
+        :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: AccountApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Account Balance
+    # Available and blocked balances.
+    # @param [Hash] opts the optional parameters
+    # @return [GetUserBalance200Response]
+    def get_user_balance(opts = {})
+      data, _status_code, _headers = get_user_balance_with_http_info(opts)
+      data
+    end
+
+    # Account Balance
+    # Available and blocked balances.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetUserBalance200Response, Integer, Hash)>] GetUserBalance200Response data, response status code and response headers
+    def get_user_balance_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.get_user_balance ...'
+      end
+      # resource path
+      local_var_path = '/user/balance'
+
+      # 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] || 'GetUserBalance200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.get_user_balance",
+        :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: AccountApi#get_user_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end