Go API client for openapi

Welcome to the Gr4vy API reference documentation. Our API is still very much a work in product and subject to change.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 1.1.0-beta
Package version: 1.0.0
Generator version: 7.11.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://gr4vy.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/FuturHealth/gr4vy-go-sdk"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value openapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value openapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.plantly.gr4vy.app

Class	Method	HTTP request	Description
APILogsAPI	ListApiLogs	Get /api-logs	List API error logs
AccountUpdaterAPI	NewAccountUpdaterJob	Post /account-updater/jobs	Create Account Updater job
AntiFraudServiceDefinitionsAPI	GetAntiFraudServiceDefinition	Get /anti-fraud-service-definitions/{anti_fraud_service_definition_id}	Get anti fraud service definition
AuditLogsAPI	ListAuditLogs	Get /audit-logs	List audit logs
BuyersAPI	DeleteBuyer	Delete /buyers/{buyer_id}	Delete buyer
BuyersAPI	DeleteBuyerShippingDetail	Delete /buyers/{buyer_id}/shipping-details/{shipping_detail_id}	Delete buyer shipping detail
BuyersAPI	GetBuyer	Get /buyers/{buyer_id}	Get buyer
BuyersAPI	ListBuyerShippingDetails	Get /buyers/{buyer_id}/shipping-details	List buyer shipping details
BuyersAPI	ListBuyers	Get /buyers	List buyers
BuyersAPI	NewBuyer	Post /buyers	New buyer
BuyersAPI	NewBuyerShippingDetail	Post /buyers/{buyer_id}/shipping-details	New buyer shipping detail
BuyersAPI	UpdateBuyer	Put /buyers/{buyer_id}	Update buyer
BuyersAPI	UpdateBuyerShippingDetail	Put /buyers/{buyer_id}/shipping-details/{shipping_detail_id}	Update buyer shipping details
CardSchemeDefinitionsAPI	ListCardSchemeDefinitions	Get /card-scheme-definitions	List card scheme definitions
CheckoutSessionsAPI	DeleteCheckoutSession	Delete /checkout/sessions/{checkout_session_id}	Delete checkout session
CheckoutSessionsAPI	GetCheckoutSession	Get /checkout/sessions/{checkout_session_id}	Get checkout session
CheckoutSessionsAPI	NewCheckoutSession	Post /checkout/sessions	New checkout session
CheckoutSessionsAPI	UpdateCheckoutSession	Put /checkout/sessions/{checkout_session_id}	Update checkout session
DigitalWalletsAPI	AddDigitalWalletDomainName	Post /digital-wallets/{digital_wallet_id}/domains	Add digital wallet domain name
DigitalWalletsAPI	DeleteDigitalWallet	Delete /digital-wallets/{digital_wallet_id}	De-register digital wallet
DigitalWalletsAPI	DeleteDigitalWalletDomainName	Delete /digital-wallets/{digital_wallet_id}/domains	Remove digital wallet domain name
DigitalWalletsAPI	GetDigitalWallet	Get /digital-wallets/{digital_wallet_id}	Get digital wallet
DigitalWalletsAPI	ListDigitalWallets	Get /digital-wallets	List digital wallets
DigitalWalletsAPI	NewDigitalWallet	Post /digital-wallets	Register digital wallet
DigitalWalletsAPI	UpdateDigitalWallet	Put /digital-wallets/{digital_wallet_id}	Update digital wallet
GiftCardServiceDefinitionsAPI	GetGiftCardServiceDefinition	Get /gift-card-service-definitions/{gift_card_service_definition_id}	Get gift card service definition
GiftCardServicesAPI	DeleteGiftCardService	Delete /gift-card-services/{gift_card_service_id}	Delete gift card service
GiftCardServicesAPI	GetGiftCardService	Get /gift-card-services/{gift_card_service_id}	Get gift card service
GiftCardServicesAPI	NewGiftCardService	Post /gift-card-services	New gift card service
GiftCardServicesAPI	UpdateGiftCardService	Put /gift-card-services/{gift_card_service_id}	Update gift card service
GiftCardServicesAPI	VerifyGiftCardService	Post /gift-card-services/verify	Verify gift card service credentials
GiftCardsAPI	CheckGiftCardBalances	Post /gift-cards/balances	Verify and check gift card balances
GiftCardsAPI	DeleteGiftCard	Delete /gift-cards/{gift_card_id}	Delete gift card
GiftCardsAPI	GetGiftCard	Get /gift-cards/{gift_card_id}	Get gift card
GiftCardsAPI	ListBuyerGiftCards	Get /buyers/gift-cards	List gift cards for buyer
GiftCardsAPI	ListGiftCards	Get /gift-cards	List gift cards
GiftCardsAPI	StoreGiftCard	Post /gift-cards	Store gift card
MerchantAccountsAPI	DeleteMerchantAccuont	Delete /merchant-accounts/{merchant_account_id}	Delete merchant account
MerchantAccountsAPI	GetMerchantAccount	Get /merchant-accounts/{merchant_account_id}	Get merchant account
MerchantAccountsAPI	ListMerchantAccounts	Get /merchant-accounts	List merchant accounts
MerchantAccountsAPI	NewMerchantAccount	Post /merchant-accounts	New merchant account
MerchantAccountsAPI	UpdateMerchantAccount	Put /merchant-accounts/{merchant_account_id}	Update merchant account
PaymentMethodDefinitionsAPI	ListPaymentMethodDefinitions	Get /payment-method-definitions	List payment method definitions
PaymentMethodsAPI	DeletePaymentMethod	Delete /payment-methods/{payment_method_id}	Delete payment method
PaymentMethodsAPI	GetPaymentMethod	Get /payment-methods/{payment_method_id}	Get payment method
PaymentMethodsAPI	ListBuyerPaymentMethods	Get /buyers/payment-methods	List payment methods for buyer
PaymentMethodsAPI	ListPaymentMethods	Get /payment-methods	List payment methods
PaymentMethodsAPI	NewPaymentMethod	Post /payment-methods	New payment method
PaymentOptionsAPI	ListPaymentOptions	Get /payment-options	List payment options
PaymentOptionsAPI	PostListPaymentOptions	Post /payment-options	List payment options with POST
PaymentServiceDefinitionsAPI	CreatePaymentServiceDefinitionSession	Post /payment-service-definitions/{payment_service_definition_id}/sessions	Create a session for a payment service
PaymentServiceDefinitionsAPI	GetPaymentServiceDefinition	Get /payment-service-definitions/{payment_service_definition_id}	Get payment service definition
PaymentServiceDefinitionsAPI	ListPaymentServiceDefinitions	Get /payment-service-definitions	List payment service definitions
PaymentServicesAPI	CreatePaymentServiceSession	Post /payment-services/{payment_service_id}/sessions	Create a session for a payment service by ID
PaymentServicesAPI	DeletePaymentService	Delete /payment-services/{payment_service_id}	Delete payment service
PaymentServicesAPI	GetPaymentService	Get /payment-services/{payment_service_id}	Get payment service
PaymentServicesAPI	ListPaymentServices	Get /payment-services	List payment services
PaymentServicesAPI	NewPaymentService	Post /payment-services	New payment service
PaymentServicesAPI	UpdatePaymentService	Put /payment-services/{payment_service_id}	Update payment service
PayoutsAPI	GetSinglePayout	Get /payouts/{payout_id}	Get payout
PayoutsAPI	ListPayouts	Get /payouts	List payouts
PayoutsAPI	NewPayout	Post /payouts	Create payout
ReportsAPI	GenerateDownloadUrl	Post /reports/{report_id}/executions/{report_execution_id}/url	Generate report download URL
ReportsAPI	GetReport	Get /reports/{report_id}	Get report
ReportsAPI	GetReportExecution	Get /report-executions/{report_execution_id}	Get report execution
ReportsAPI	ListAllReportExecutions	Get /report-executions	List all report executions
ReportsAPI	ListReportExecutions	Get /reports/{report_id}/executions	List executions for report
ReportsAPI	ListReports	Get /reports	List reports
ReportsAPI	NewReport	Post /reports	New report
ReportsAPI	UpdateReport	Put /reports/{report_id}	Update report
RolesAPI	DeleteRoleAssignment	Delete /roles/assignments/{role_assignment_id}	Delete role assignment
RolesAPI	ListRoleAssignments	Get /roles/assignments	List role assignments
RolesAPI	ListRoles	Get /roles	List roles
RolesAPI	NewRoleAssignment	Post /roles/assignments	New role assignment
TokensAPI	DeleteNetworkToken	Delete /payment-methods/{payment_method_id}/network-tokens/{network_token_id}	Delete network token
TokensAPI	DeletePaymentServiceToken	Delete /payment-methods/{payment_method_id}/payment-service-tokens/{payment_service_token_id}	Delete payment service token
TokensAPI	GetNetworkTokens	Get /payment-methods/{payment_method_id}/network-tokens	Get network tokens
TokensAPI	GetPaymentServiceTokens	Get /payment-methods/{payment_method_id}/payment-service-tokens	Get payment service tokens
TokensAPI	IssueCryptogram	Post /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/cryptogram	Issue cryptogram
TokensAPI	ProvisionNetworkToken	Post /payment-methods/{payment_method_id}/network-tokens	Provision network token
TokensAPI	ProvisionPaymentServiceToken	Post /payment-methods/{payment_method_id}/payment-service-tokens	Provision payment service token
TokensAPI	ResumeNetworkToken	Post /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/resume	Resume network token
TokensAPI	SuspendNetworkToken	Post /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/suspend	Suspend network token
TransactionsAPI	CaptureTransaction	Post /transactions/{transaction_id}/capture	Capture transaction
TransactionsAPI	GetRefund	Get /transactions/{transaction_id}/refunds/{refund_id}	Get refund
TransactionsAPI	GetSingleRefund	Get /refunds/{refund_id}	Get refund
TransactionsAPI	GetTransaction	Get /transactions/{transaction_id}	Get transaction
TransactionsAPI	GetTransactionSettlement	Get /transactions/{transaction_id}/settlements/{settlement_id}	Get settlement
TransactionsAPI	GetTransactionSettlements	Get /transactions/{transaction_id}/settlements	List settlements for transaction
TransactionsAPI	ListTransactionRefunds	Get /transactions/{transaction_id}/refunds	List refunds
TransactionsAPI	ListTransactions	Get /transactions	List transactions
TransactionsAPI	NewRefund	Post /transactions/{transaction_id}/refunds	Refund transaction
TransactionsAPI	NewTransaction	Post /transactions	New transaction
TransactionsAPI	RefundAll	Post /transactions/{transaction_id}/refunds/all	Refund all instruments in a transaction
TransactionsAPI	SyncTransaction	Post /transactions/{transaction_id}/sync	Sync transaction
TransactionsAPI	VoidTransaction	Post /transactions/{transaction_id}/void	Void transaction
VaultForwardAPI	MakeVaultForward	Post /vault-forward	Forward PCI data

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), openapi.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]

# Packages

# README