bancard-pix-service-client

BancardPixServiceClient - the Ruby gem for the API V1

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 1.0.0
• Generator version: 7.5.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build bancard-pix-service-client.gemspec

Then either install the gem locally:

gem install ./bancard-pix-service-client-1.0.0.gem

(for development, run gem install --dev ./bancard-pix-service-client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'bancard-pix-service-client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'bancard-pix-service-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'bancard-pix-service-client'

# Setup authorization
BancardPixServiceClient.configure do |config|
  # Configure HTTP basic authorization: basic_auth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = BancardPixServiceClient::CashiersApi.new
commerce_id = 56 # Integer | commerce_id

begin
  #List of cashiers
  result = api_instance.list_cashier_infos(commerce_id)
  p result
rescue BancardPixServiceClient::ApiError => e
  puts "Exception when calling CashiersApi->list_cashier_infos: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://www.example.com

Class	Method	HTTP request	Description
BancardPixServiceClient::CashiersApi	list_cashier_infos	GET /pix/api/commerces/{commerce_id}/cashiers	List of cashiers
BancardPixServiceClient::CashiersApi	list_with_branch_id_cashier_infos	GET /pix/api/commerces/{commerce_id}/branches/{branch_id}/cashiers	List of cashiers
BancardPixServiceClient::CommerceBranchUsersApi	commerce_branch_users_report	GET /pix/api/commerce_branch_users	Obtain commerce branch users report
BancardPixServiceClient::CommerceBranchUsersApi	create_commerce_branch_user	POST /pix/api/commerce_branch_users	Finds commerce branch user by commerce_id and user_id. If exsts, updates commerce branch user's commerce_branch_id. If not, creates a new commerce branch user
BancardPixServiceClient::CommerceBranchUsersApi	destroy_commerce_branch_user	DELETE /pix/api/commerce_branch_users	Destroy commerce branch user by user_id and commerce_id
BancardPixServiceClient::PaymentHooksApi	cancel_payment_hook	POST /pix/api/payment_hooks/{id}/cancel	Cancel payment hook
BancardPixServiceClient::PaymentHooksApi	create_payment_hook	POST /pix/api/payment_hooks	Create payment hook
BancardPixServiceClient::PaymentsApi	payments_download_report	GET /pix/api/payments/report	Download payments report
BancardPixServiceClient::PaymentsApi	payments_report	GET /pix/api/payments	Get payment report
BancardPixServiceClient::PaymentsApi	show_payment	GET /pix/api/payments/{id}	Get a payment information

Documentation for Models

• BancardPixServiceClient::CashierInfo
• BancardPixServiceClient::CommerceBranchInfo
• BancardPixServiceClient::CommerceBranchUser
• BancardPixServiceClient::CommerceBranchUserCreateRequest
• BancardPixServiceClient::CommerceBranchUserCreateRequestCommerceBranchUser
• BancardPixServiceClient::CommerceBranchUsersReport
• BancardPixServiceClient::ErrorResponse
• BancardPixServiceClient::ErrorResponseMessagesInner
• BancardPixServiceClient::ListCashierInfos
• BancardPixServiceClient::Payment
• BancardPixServiceClient::PaymentHook
• BancardPixServiceClient::PaymentHookCreateRequest
• BancardPixServiceClient::PaymentHookCreateRequestPaymentHook
• BancardPixServiceClient::PaymentsDownloadReport
• BancardPixServiceClient::PaymentsReport
• BancardPixServiceClient::ShowCommerceBranchUser
• BancardPixServiceClient::ShowPayment
• BancardPixServiceClient::ShowPaymentHook

Documentation for Authorization

Authentication schemes defined for the API:

basic_auth

• Type: HTTP basic authentication