controllers

package
v0.0.0-...-05f3020 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 1, 2023 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package pagarmeapisdk

This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewBaseController 

func NewBaseController(cb callBuilderFactory) *baseController

Types

type BalanceOperationsController 

type BalanceOperationsController struct {
	// contains filtered or unexported fields
}

func NewBalanceOperationsController 

func NewBalanceOperationsController(baseController baseController) *BalanceOperationsController

func (*BalanceOperationsController) GetBalanceOperationById 

func (b *BalanceOperationsController) GetBalanceOperationById(ctx context.Context, id int64) (
	https.ApiResponse[models.GetBalanceOperationResponse],
	error)

TODO: type endpoint description here

func (*BalanceOperationsController) GetBalanceOperations 

func (b *BalanceOperationsController) GetBalanceOperations(
	ctx context.Context,
	status *string,
	createdSince *time.Time,
	createdUntil *time.Time) (
	https.ApiResponse[models.ListBalanceOperationResponse],
	error)

TODO: type endpoint description here

type BinController 

type BinController struct {
	// contains filtered or unexported fields
}

func NewBinController 

func NewBinController(baseController baseController) *BinController

func (*BinController) GetBin 

func (b *BinController) GetBin(ctx context.Context, bankIdentifier string) (
	https.ApiResponse[models.GetBinResponse],
	error)

TODO: type endpoint description here

type ChargesController 

type ChargesController struct {
	// contains filtered or unexported fields
}

func NewChargesController 

func NewChargesController(baseController baseController) *ChargesController

func (*ChargesController) CancelCharge 

func (c *ChargesController) CancelCharge(
	ctx context.Context,
	chargeId string,
	request *models.CreateCancelChargeRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

Cancel a charge

func (*ChargesController) CaptureCharge 

func (c *ChargesController) CaptureCharge(
	ctx context.Context,
	chargeId string,
	request *models.CreateCaptureChargeRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

Captures a charge

func (*ChargesController) ConfirmPayment 

func (c *ChargesController) ConfirmPayment(
	ctx context.Context,
	chargeId string,
	request *models.CreateConfirmPaymentRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

TODO: type endpoint description here

func (*ChargesController) CreateCharge 

func (c *ChargesController) CreateCharge(
	ctx context.Context,
	request *models.CreateChargeRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

Creates a new charge

func (*ChargesController) GetCharge 

func (c *ChargesController) GetCharge(ctx context.Context, chargeId string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

Get a charge from its id

func (*ChargesController) GetChargeTransactions 

func (c *ChargesController) GetChargeTransactions(
	ctx context.Context,
	chargeId string,
	page *int,
	size *int) (
	https.ApiResponse[models.ListChargeTransactionsResponse],
	error)

TODO: type endpoint description here

func (*ChargesController) GetCharges 

func (c *ChargesController) GetCharges(
	ctx context.Context,
	page *int,
	size *int,
	code *string,
	status *string,
	paymentMethod *string,
	customerId *string,
	orderId *string,
	createdSince *time.Time,
	createdUntil *time.Time) (
	https.ApiResponse[models.ListChargesResponse],
	error)

Lists all charges

func (*ChargesController) GetChargesSummary 

func (c *ChargesController) GetChargesSummary(
	ctx context.Context,
	status string,
	createdSince *time.Time,
	createdUntil *time.Time) (
	https.ApiResponse[models.GetChargesSummaryResponse],
	error)

TODO: type endpoint description here

func (*ChargesController) RetryCharge 

func (c *ChargesController) RetryCharge(
	ctx context.Context,
	chargeId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

Retries a charge

func (*ChargesController) UpdateChargeCard 

func (c *ChargesController) UpdateChargeCard(
	ctx context.Context,
	chargeId string,
	request *models.UpdateChargeCardRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

Updates the card from a charge

func (*ChargesController) UpdateChargeDueDate 

func (c *ChargesController) UpdateChargeDueDate(
	ctx context.Context,
	chargeId string,
	request *models.UpdateChargeDueDateRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

Updates the due date from a charge

func (*ChargesController) UpdateChargeMetadata 

func (c *ChargesController) UpdateChargeMetadata(
	ctx context.Context,
	chargeId string,
	request *models.UpdateMetadataRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

Updates the metadata from a charge

func (*ChargesController) UpdateChargePaymentMethod 

func (c *ChargesController) UpdateChargePaymentMethod(
	ctx context.Context,
	chargeId string,
	request *models.UpdateChargePaymentMethodRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetChargeResponse],
	error)

Updates a charge's payment method

type CustomersController 

type CustomersController struct {
	// contains filtered or unexported fields
}

func NewCustomersController 

func NewCustomersController(baseController baseController) *CustomersController

func (*CustomersController) CreateAccessToken 

func (c *CustomersController) CreateAccessToken(
	ctx context.Context,
	customerId string,
	request *models.CreateAccessTokenRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetAccessTokenResponse],
	error)

Creates a access token for a customer

func (*CustomersController) CreateAddress 

func (c *CustomersController) CreateAddress(
	ctx context.Context,
	customerId string,
	request *models.CreateAddressRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetAddressResponse],
	error)

Creates a new address for a customer

func (*CustomersController) CreateCard 

func (c *CustomersController) CreateCard(
	ctx context.Context,
	customerId string,
	request *models.CreateCardRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetCardResponse],
	error)

Creates a new card for a customer

func (*CustomersController) CreateCustomer 

func (c *CustomersController) CreateCustomer(
	ctx context.Context,
	request *models.CreateCustomerRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetCustomerResponse],
	error)

Creates a new customer

func (*CustomersController) DeleteAccessToken 

func (c *CustomersController) DeleteAccessToken(
	ctx context.Context,
	customerId string,
	tokenId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetAccessTokenResponse],
	error)

Delete a customer's access token

func (*CustomersController) DeleteAccessTokens 

func (c *CustomersController) DeleteAccessTokens(ctx context.Context, customerId string) (
	https.ApiResponse[models.ListAccessTokensResponse],
	error)

Delete a Customer's access tokens

func (*CustomersController) DeleteAddress 

func (c *CustomersController) DeleteAddress(
	ctx context.Context,
	customerId string,
	addressId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetAddressResponse],
	error)

Delete a Customer's address

func (*CustomersController) DeleteCard 

func (c *CustomersController) DeleteCard(
	ctx context.Context,
	customerId string,
	cardId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetCardResponse],
	error)

Delete a customer's card

func (*CustomersController) GetAccessToken 

func (c *CustomersController) GetAccessToken(
	ctx context.Context,
	customerId string,
	tokenId string) (
	https.ApiResponse[models.GetAccessTokenResponse],
	error)

Get a Customer's access token

func (*CustomersController) GetAccessTokens 

func (c *CustomersController) GetAccessTokens(
	ctx context.Context,
	customerId string,
	page *int,
	size *int) (
	https.ApiResponse[models.ListAccessTokensResponse],
	error)

Get all access tokens from a customer

func (*CustomersController) GetAddress 

func (c *CustomersController) GetAddress(
	ctx context.Context,
	customerId string,
	addressId string) (
	https.ApiResponse[models.GetAddressResponse],
	error)

Get a customer's address

func (*CustomersController) GetAddresses 

func (c *CustomersController) GetAddresses(
	ctx context.Context,
	customerId string,
	page *int,
	size *int) (
	https.ApiResponse[models.ListAddressesResponse],
	error)

Gets all adressess from a customer

func (*CustomersController) GetCard 

func (c *CustomersController) GetCard(
	ctx context.Context,
	customerId string,
	cardId string) (
	https.ApiResponse[models.GetCardResponse],
	error)

Get a customer's card

func (*CustomersController) GetCards 

func (c *CustomersController) GetCards(
	ctx context.Context,
	customerId string,
	page *int,
	size *int) (
	https.ApiResponse[models.ListCardsResponse],
	error)

Get all cards from a customer

func (*CustomersController) GetCustomer 

func (c *CustomersController) GetCustomer(ctx context.Context, customerId string) (
	https.ApiResponse[models.GetCustomerResponse],
	error)

Get a customer

func (*CustomersController) GetCustomers 

func (c *CustomersController) GetCustomers(
	ctx context.Context,
	name *string,
	document *string,
	page *int,
	size *int,
	email *string,
	code *string) (
	https.ApiResponse[models.ListCustomersResponse],
	error)

Get all Customers

func (*CustomersController) RenewCard 

func (c *CustomersController) RenewCard(
	ctx context.Context,
	customerId string,
	cardId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetCardResponse],
	error)

Renew a card

func (*CustomersController) UpdateAddress 

func (c *CustomersController) UpdateAddress(
	ctx context.Context,
	customerId string,
	addressId string,
	request *models.UpdateAddressRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetAddressResponse],
	error)

Updates an address

func (*CustomersController) UpdateCard 

func (c *CustomersController) UpdateCard(
	ctx context.Context,
	customerId string,
	cardId string,
	request *models.UpdateCardRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetCardResponse],
	error)

Updates a card

func (*CustomersController) UpdateCustomer 

func (c *CustomersController) UpdateCustomer(
	ctx context.Context,
	customerId string,
	request *models.UpdateCustomerRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetCustomerResponse],
	error)

Updates a customer

func (*CustomersController) UpdateCustomerMetadata 

func (c *CustomersController) UpdateCustomerMetadata(
	ctx context.Context,
	customerId string,
	request *models.UpdateMetadataRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetCustomerResponse],
	error)

Updates the metadata a customer

type InvoicesController 

type InvoicesController struct {
	// contains filtered or unexported fields
}

func NewInvoicesController 

func NewInvoicesController(baseController baseController) *InvoicesController

func (*InvoicesController) CancelInvoice 

func (i *InvoicesController) CancelInvoice(
	ctx context.Context,
	invoiceId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetInvoiceResponse],
	error)

Cancels an invoice

func (*InvoicesController) CreateInvoice 

func (i *InvoicesController) CreateInvoice(
	ctx context.Context,
	subscriptionId string,
	cycleId string,
	request *models.CreateInvoiceRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetInvoiceResponse],
	error)

Create an Invoice

func (*InvoicesController) GetInvoice 

func (i *InvoicesController) GetInvoice(ctx context.Context, invoiceId string) (
	https.ApiResponse[models.GetInvoiceResponse],
	error)

Gets an invoice

func (*InvoicesController) GetInvoices 

func (i *InvoicesController) GetInvoices(
	ctx context.Context,
	page *int,
	size *int,
	code *string,
	customerId *string,
	subscriptionId *string,
	createdSince *time.Time,
	createdUntil *time.Time,
	status *string,
	dueSince *time.Time,
	dueUntil *time.Time,
	customerDocument *string) (
	https.ApiResponse[models.ListInvoicesResponse],
	error)

Gets all invoices

func (*InvoicesController) GetPartialInvoice 

func (i *InvoicesController) GetPartialInvoice(ctx context.Context, subscriptionId string) (
	https.ApiResponse[models.GetInvoiceResponse],
	error)

TODO: type endpoint description here

func (*InvoicesController) UpdateInvoiceMetadata 

func (i *InvoicesController) UpdateInvoiceMetadata(
	ctx context.Context,
	invoiceId string,
	request *models.UpdateMetadataRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetInvoiceResponse],
	error)

Updates the metadata from an invoice

func (*InvoicesController) UpdateInvoiceStatus 

func (i *InvoicesController) UpdateInvoiceStatus(
	ctx context.Context,
	invoiceId string,
	request *models.UpdateInvoiceStatusRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetInvoiceResponse],
	error)

Updates the status from an invoice

type OrdersController 

type OrdersController struct {
	// contains filtered or unexported fields
}

func NewOrdersController 

func NewOrdersController(baseController baseController) *OrdersController

func (*OrdersController) CloseOrder 

func (o *OrdersController) CloseOrder(
	ctx context.Context,
	id string,
	request *models.UpdateOrderStatusRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetOrderResponse],
	error)

TODO: type endpoint description here

func (*OrdersController) CreateOrder 

func (o *OrdersController) CreateOrder(
	ctx context.Context,
	body *models.CreateOrderRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetOrderResponse],
	error)

Creates a new Order

func (*OrdersController) CreateOrderItem 

func (o *OrdersController) CreateOrderItem(
	ctx context.Context,
	orderId string,
	request *models.CreateOrderItemRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetOrderItemResponse],
	error)

TODO: type endpoint description here

func (*OrdersController) DeleteAllOrderItems 

func (o *OrdersController) DeleteAllOrderItems(
	ctx context.Context,
	orderId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetOrderResponse],
	error)

TODO: type endpoint description here

func (*OrdersController) DeleteOrderItem 

func (o *OrdersController) DeleteOrderItem(
	ctx context.Context,
	orderId string,
	itemId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetOrderItemResponse],
	error)

TODO: type endpoint description here

func (*OrdersController) GetOrder 

func (o *OrdersController) GetOrder(ctx context.Context, orderId string) (
	https.ApiResponse[models.GetOrderResponse],
	error)

Gets an order

func (*OrdersController) GetOrderItem 

func (o *OrdersController) GetOrderItem(
	ctx context.Context,
	orderId string,
	itemId string) (
	https.ApiResponse[models.GetOrderItemResponse],
	error)

TODO: type endpoint description here

func (*OrdersController) GetOrders 

func (o *OrdersController) GetOrders(
	ctx context.Context,
	page *int,
	size *int,
	code *string,
	status *string,
	createdSince *time.Time,
	createdUntil *time.Time,
	customerId *string) (
	https.ApiResponse[models.ListOrderResponse],
	error)

Gets all orders

func (*OrdersController) UpdateOrderItem 

func (o *OrdersController) UpdateOrderItem(
	ctx context.Context,
	orderId string,
	itemId string,
	request *models.UpdateOrderItemRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetOrderItemResponse],
	error)

TODO: type endpoint description here

func (*OrdersController) UpdateOrderMetadata 

func (o *OrdersController) UpdateOrderMetadata(
	ctx context.Context,
	orderId string,
	request *models.UpdateMetadataRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetOrderResponse],
	error)

Updates the metadata from an order

type PayablesController 

type PayablesController struct {
	// contains filtered or unexported fields
}

func NewPayablesController 

func NewPayablesController(baseController baseController) *PayablesController

func (*PayablesController) GetPayableById 

func (p *PayablesController) GetPayableById(ctx context.Context, id int64) (
	https.ApiResponse[models.GetPayableResponse],
	error)

TODO: type endpoint description here

func (*PayablesController) GetPayables 

func (p *PayablesController) GetPayables(
	ctx context.Context,
	mType *string,
	splitId *string,
	bulkAnticipationId *string,
	installment *int,
	status *string,
	recipientId *string,
	amount *int,
	chargeId *string,
	paymentDateUntil *string,
	paymentDateSince *time.Time,
	updatedUntil *time.Time,
	updatedSince *time.Time,
	createdUntil *time.Time,
	createdSince *time.Time,
	liquidationArrangementId *string,
	page *int,
	size *int,
	gatewayId *int64) (
	https.ApiResponse[models.ListPayablesResponse],
	error)

TODO: type endpoint description here

type PlansController 

type PlansController struct {
	// contains filtered or unexported fields
}

func NewPlansController 

func NewPlansController(baseController baseController) *PlansController

func (*PlansController) CreatePlan 

func (p *PlansController) CreatePlan(
	ctx context.Context,
	body *models.CreatePlanRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetPlanResponse],
	error)

Creates a new plan

func (*PlansController) CreatePlanItem 

func (p *PlansController) CreatePlanItem(
	ctx context.Context,
	planId string,
	request *models.CreatePlanItemRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetPlanItemResponse],
	error)

Adds a new item to a plan

func (*PlansController) DeletePlan 

func (p *PlansController) DeletePlan(
	ctx context.Context,
	planId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetPlanResponse],
	error)

Deletes a plan

func (*PlansController) DeletePlanItem 

func (p *PlansController) DeletePlanItem(
	ctx context.Context,
	planId string,
	planItemId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetPlanItemResponse],
	error)

Removes an item from a plan

func (*PlansController) GetPlan 

func (p *PlansController) GetPlan(ctx context.Context, planId string) (
	https.ApiResponse[models.GetPlanResponse],
	error)

Gets a plan

func (*PlansController) GetPlanItem 

func (p *PlansController) GetPlanItem(
	ctx context.Context,
	planId string,
	planItemId string) (
	https.ApiResponse[models.GetPlanItemResponse],
	error)

Gets a plan item

func (*PlansController) GetPlans 

func (p *PlansController) GetPlans(
	ctx context.Context,
	page *int,
	size *int,
	name *string,
	status *string,
	billingType *string,
	createdSince *time.Time,
	createdUntil *time.Time) (
	https.ApiResponse[models.ListPlansResponse],
	error)

Gets all plans

func (*PlansController) UpdatePlan 

func (p *PlansController) UpdatePlan(
	ctx context.Context,
	planId string,
	request *models.UpdatePlanRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetPlanResponse],
	error)

Updates a plan

func (*PlansController) UpdatePlanItem 

func (p *PlansController) UpdatePlanItem(
	ctx context.Context,
	planId string,
	planItemId string,
	body *models.UpdatePlanItemRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetPlanItemResponse],
	error)

Updates a plan item

func (*PlansController) UpdatePlanMetadata 

func (p *PlansController) UpdatePlanMetadata(
	ctx context.Context,
	planId string,
	request *models.UpdateMetadataRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetPlanResponse],
	error)

Updates the metadata from a plan

type RecipientsController 

type RecipientsController struct {
	// contains filtered or unexported fields
}

func NewRecipientsController 

func NewRecipientsController(baseController baseController) *RecipientsController

func (*RecipientsController) CreateAnticipation 

func (r *RecipientsController) CreateAnticipation(
	ctx context.Context,
	recipientId string,
	request *models.CreateAnticipationRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetAnticipationResponse],
	error)

Creates an anticipation

func (*RecipientsController) CreateRecipient 

func (r *RecipientsController) CreateRecipient(
	ctx context.Context,
	request *models.CreateRecipientRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetRecipientResponse],
	error)

Creates a new recipient

func (*RecipientsController) CreateTransfer 

func (r *RecipientsController) CreateTransfer(
	ctx context.Context,
	recipientId string,
	request *models.CreateTransferRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetTransferResponse],
	error)

Creates a transfer for a recipient

func (*RecipientsController) CreateWithdraw 

func (r *RecipientsController) CreateWithdraw(
	ctx context.Context,
	recipientId string,
	request *models.CreateWithdrawRequest) (
	https.ApiResponse[models.GetWithdrawResponse],
	error)

TODO: type endpoint description here

func (*RecipientsController) GetAnticipation 

func (r *RecipientsController) GetAnticipation(
	ctx context.Context,
	recipientId string,
	anticipationId string) (
	https.ApiResponse[models.GetAnticipationResponse],
	error)

Gets an anticipation

func (*RecipientsController) GetAnticipationLimits 

func (r *RecipientsController) GetAnticipationLimits(
	ctx context.Context,
	recipientId string,
	timeframe string,
	paymentDate time.Time) (
	https.ApiResponse[models.GetAnticipationLimitResponse],
	error)

Gets the anticipation limits for a recipient

func (*RecipientsController) GetAnticipations 

func (r *RecipientsController) GetAnticipations(
	ctx context.Context,
	recipientId string,
	page *int,
	size *int,
	status *string,
	timeframe *string,
	paymentDateSince *time.Time,
	paymentDateUntil *time.Time,
	createdSince *time.Time,
	createdUntil *time.Time) (
	https.ApiResponse[models.ListAnticipationResponse],
	error)

Retrieves a paginated list of anticipations from a recipient

func (*RecipientsController) GetBalance 

func (r *RecipientsController) GetBalance(ctx context.Context, recipientId string) (
	https.ApiResponse[models.GetBalanceResponse],
	error)

Get balance information for a recipient

func (*RecipientsController) GetDefaultRecipient 

func (r *RecipientsController) GetDefaultRecipient(ctx context.Context) (
	https.ApiResponse[models.GetRecipientResponse],
	error)

TODO: type endpoint description here

func (*RecipientsController) GetRecipient 

func (r *RecipientsController) GetRecipient(ctx context.Context, recipientId string) (
	https.ApiResponse[models.GetRecipientResponse],
	error)

Retrieves recipient information

func (*RecipientsController) GetRecipientByCode 

func (r *RecipientsController) GetRecipientByCode(ctx context.Context, code string) (
	https.ApiResponse[models.GetRecipientResponse],
	error)

Retrieves recipient information

func (*RecipientsController) GetRecipients 

func (r *RecipientsController) GetRecipients(
	ctx context.Context,
	page *int,
	size *int) (
	https.ApiResponse[models.ListRecipientResponse],
	error)

Retrieves paginated recipients information

func (*RecipientsController) GetTransfer 

func (r *RecipientsController) GetTransfer(
	ctx context.Context,
	recipientId string,
	transferId string) (
	https.ApiResponse[models.GetTransferResponse],
	error)

Gets a transfer

func (*RecipientsController) GetTransfers 

func (r *RecipientsController) GetTransfers(
	ctx context.Context,
	recipientId string,
	page *int,
	size *int,
	status *string,
	createdSince *time.Time,
	createdUntil *time.Time) (
	https.ApiResponse[models.ListTransferResponse],
	error)

Gets a paginated list of transfers for the recipient

func (*RecipientsController) GetWithdrawById 

func (r *RecipientsController) GetWithdrawById(
	ctx context.Context,
	recipientId string,
	withdrawalId string) (
	https.ApiResponse[models.GetWithdrawResponse],
	error)

TODO: type endpoint description here

func (*RecipientsController) GetWithdrawals 

func (r *RecipientsController) GetWithdrawals(
	ctx context.Context,
	recipientId string,
	page *int,
	size *int,
	status *string,
	createdSince *time.Time,
	createdUntil *time.Time) (
	https.ApiResponse[models.ListWithdrawals],
	error)

Gets a paginated list of transfers for the recipient

func (*RecipientsController) UpdateAutomaticAnticipationSettings 

func (r *RecipientsController) UpdateAutomaticAnticipationSettings(
	ctx context.Context,
	recipientId string,
	request *models.UpdateAutomaticAnticipationSettingsRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetRecipientResponse],
	error)

Updates recipient metadata

func (*RecipientsController) UpdateRecipient 

func (r *RecipientsController) UpdateRecipient(
	ctx context.Context,
	recipientId string,
	request *models.UpdateRecipientRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetRecipientResponse],
	error)

Updates a recipient

func (*RecipientsController) UpdateRecipientDefaultBankAccount 

func (r *RecipientsController) UpdateRecipientDefaultBankAccount(
	ctx context.Context,
	recipientId string,
	request *models.UpdateRecipientBankAccountRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetRecipientResponse],
	error)

Updates the default bank account from a recipient

func (*RecipientsController) UpdateRecipientMetadata 

func (r *RecipientsController) UpdateRecipientMetadata(
	ctx context.Context,
	recipientId string,
	request *models.UpdateMetadataRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetRecipientResponse],
	error)

Updates recipient metadata

func (*RecipientsController) UpdateRecipientTransferSettings 

func (r *RecipientsController) UpdateRecipientTransferSettings(
	ctx context.Context,
	recipientId string,
	request *models.UpdateTransferSettingsRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetRecipientResponse],
	error)

TODO: type endpoint description here

type SubscriptionsController 

type SubscriptionsController struct {
	// contains filtered or unexported fields
}

func NewSubscriptionsController 

func NewSubscriptionsController(baseController baseController) *SubscriptionsController

func (*SubscriptionsController) CancelSubscription 

func (s *SubscriptionsController) CancelSubscription(
	ctx context.Context,
	subscriptionId string,
	request *models.CreateCancelSubscriptionRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Cancels a subscription

func (*SubscriptionsController) CreateAnUsage 

func (s *SubscriptionsController) CreateAnUsage(
	ctx context.Context,
	subscriptionId string,
	itemId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetUsageResponse],
	error)

Create Usage

func (*SubscriptionsController) CreateDiscount 

func (s *SubscriptionsController) CreateDiscount(
	ctx context.Context,
	subscriptionId string,
	request *models.CreateDiscountRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetDiscountResponse],
	error)

Creates a discount

func (*SubscriptionsController) CreateIncrement 

func (s *SubscriptionsController) CreateIncrement(
	ctx context.Context,
	subscriptionId string,
	request *models.CreateIncrementRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetIncrementResponse],
	error)

Creates a increment

func (*SubscriptionsController) CreateSubscription 

func (s *SubscriptionsController) CreateSubscription(
	ctx context.Context,
	body *models.CreateSubscriptionRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Creates a new subscription

func (*SubscriptionsController) CreateSubscriptionItem 

func (s *SubscriptionsController) CreateSubscriptionItem(
	ctx context.Context,
	subscriptionId string,
	request *models.CreateSubscriptionItemRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionItemResponse],
	error)

Creates a new Subscription item

func (*SubscriptionsController) CreateUsage 

func (s *SubscriptionsController) CreateUsage(
	ctx context.Context,
	subscriptionId string,
	itemId string,
	body *models.CreateUsageRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetUsageResponse],
	error)

Creates a usage

func (*SubscriptionsController) DeleteDiscount 

func (s *SubscriptionsController) DeleteDiscount(
	ctx context.Context,
	subscriptionId string,
	discountId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetDiscountResponse],
	error)

Deletes a discount

func (*SubscriptionsController) DeleteIncrement 

func (s *SubscriptionsController) DeleteIncrement(
	ctx context.Context,
	subscriptionId string,
	incrementId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetIncrementResponse],
	error)

Deletes a increment

func (*SubscriptionsController) DeleteSubscriptionItem 

func (s *SubscriptionsController) DeleteSubscriptionItem(
	ctx context.Context,
	subscriptionId string,
	subscriptionItemId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionItemResponse],
	error)

Deletes a subscription item

func (*SubscriptionsController) DeleteUsage 

func (s *SubscriptionsController) DeleteUsage(
	ctx context.Context,
	subscriptionId string,
	itemId string,
	usageId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetUsageResponse],
	error)

Deletes a usage

func (*SubscriptionsController) GetDiscountById 

func (s *SubscriptionsController) GetDiscountById(
	ctx context.Context,
	subscriptionId string,
	discountId string) (
	https.ApiResponse[models.GetDiscountResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) GetDiscounts 

func (s *SubscriptionsController) GetDiscounts(
	ctx context.Context,
	subscriptionId string,
	page int,
	size int) (
	https.ApiResponse[models.ListDiscountsResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) GetIncrementById 

func (s *SubscriptionsController) GetIncrementById(
	ctx context.Context,
	subscriptionId string,
	incrementId string) (
	https.ApiResponse[models.GetIncrementResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) GetIncrements 

func (s *SubscriptionsController) GetIncrements(
	ctx context.Context,
	subscriptionId string,
	page *int,
	size *int) (
	https.ApiResponse[models.ListIncrementsResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) GetSubscription 

func (s *SubscriptionsController) GetSubscription(ctx context.Context, subscriptionId string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Gets a subscription

func (*SubscriptionsController) GetSubscriptionCycleById 

func (s *SubscriptionsController) GetSubscriptionCycleById(
	ctx context.Context,
	subscriptionId string,
	cycleId string) (
	https.ApiResponse[models.GetPeriodResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) GetSubscriptionCycles 

func (s *SubscriptionsController) GetSubscriptionCycles(
	ctx context.Context,
	subscriptionId string,
	page string,
	size string) (
	https.ApiResponse[models.ListCyclesResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) GetSubscriptionItem 

func (s *SubscriptionsController) GetSubscriptionItem(
	ctx context.Context,
	subscriptionId string,
	itemId string) (
	https.ApiResponse[models.GetSubscriptionItemResponse],
	error)

Get Subscription Item

func (*SubscriptionsController) GetSubscriptionItems 

func (s *SubscriptionsController) GetSubscriptionItems(
	ctx context.Context,
	subscriptionId string,
	page *int,
	size *int,
	name *string,
	code *string,
	status *string,
	description *string,
	createdSince *string,
	createdUntil *string) (
	https.ApiResponse[models.ListSubscriptionItemsResponse],
	error)

Get Subscription Items

func (*SubscriptionsController) GetSubscriptions 

func (s *SubscriptionsController) GetSubscriptions(
	ctx context.Context,
	page *int,
	size *int,
	code *string,
	billingType *string,
	customerId *string,
	planId *string,
	cardId *string,
	status *string,
	nextBillingSince *time.Time,
	nextBillingUntil *time.Time,
	createdSince *time.Time,
	createdUntil *time.Time) (
	https.ApiResponse[models.ListSubscriptionsResponse],
	error)

Gets all subscriptions

func (*SubscriptionsController) GetUsageReport 

func (s *SubscriptionsController) GetUsageReport(
	ctx context.Context,
	subscriptionId string,
	periodId string) (
	https.ApiResponse[models.GetUsageReportResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) GetUsages 

func (s *SubscriptionsController) GetUsages(
	ctx context.Context,
	subscriptionId string,
	itemId string,
	page *int,
	size *int,
	code *string,
	group *string,
	usedSince *time.Time,
	usedUntil *time.Time) (
	https.ApiResponse[models.ListUsagesResponse],
	error)

Lists all usages from a subscription item

func (*SubscriptionsController) RenewSubscription 

func (s *SubscriptionsController) RenewSubscription(
	ctx context.Context,
	subscriptionId string,
	idempotencyKey *string) (
	https.ApiResponse[models.GetPeriodResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) UpdateCurrentCycleStatus 

func (s *SubscriptionsController) UpdateCurrentCycleStatus(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateCurrentCycleStatusRequest,
	idempotencyKey *string) (
	*http.Response,
	error)

TODO: type endpoint description here

func (*SubscriptionsController) UpdateLatestPeriodEndAt 

func (s *SubscriptionsController) UpdateLatestPeriodEndAt(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateCurrentCycleEndDateRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) UpdateSplitSubscription 

func (s *SubscriptionsController) UpdateSplitSubscription(
	ctx context.Context,
	id string,
	request *models.UpdateSubscriptionSplitRequest) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) UpdateSubscriptionAffiliationId 

func (s *SubscriptionsController) UpdateSubscriptionAffiliationId(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateSubscriptionAffiliationIdRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

TODO: type endpoint description here

func (*SubscriptionsController) UpdateSubscriptionBillingDate 

func (s *SubscriptionsController) UpdateSubscriptionBillingDate(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateSubscriptionBillingDateRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Updates the billing date from a subscription

func (*SubscriptionsController) UpdateSubscriptionCard 

func (s *SubscriptionsController) UpdateSubscriptionCard(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateSubscriptionCardRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Updates the credit card from a subscription

func (*SubscriptionsController) UpdateSubscriptionDueDays 

func (s *SubscriptionsController) UpdateSubscriptionDueDays(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateSubscriptionDueDaysRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Updates the boleto due days from a subscription

func (*SubscriptionsController) UpdateSubscriptionItem 

func (s *SubscriptionsController) UpdateSubscriptionItem(
	ctx context.Context,
	subscriptionId string,
	itemId string,
	body *models.UpdateSubscriptionItemRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionItemResponse],
	error)

Updates a subscription item

func (*SubscriptionsController) UpdateSubscriptionMetadata 

func (s *SubscriptionsController) UpdateSubscriptionMetadata(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateMetadataRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Updates the metadata from a subscription

func (*SubscriptionsController) UpdateSubscriptionMiniumPrice 

func (s *SubscriptionsController) UpdateSubscriptionMiniumPrice(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateSubscriptionMinimumPriceRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Atualização do valor mínimo da assinatura

func (*SubscriptionsController) UpdateSubscriptionPaymentMethod 

func (s *SubscriptionsController) UpdateSubscriptionPaymentMethod(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateSubscriptionPaymentMethodRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Updates the payment method from a subscription

func (*SubscriptionsController) UpdateSubscriptionStartAt 

func (s *SubscriptionsController) UpdateSubscriptionStartAt(
	ctx context.Context,
	subscriptionId string,
	request *models.UpdateSubscriptionStartAtRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetSubscriptionResponse],
	error)

Updates the start at date from a subscription

type TokensController 

type TokensController struct {
	// contains filtered or unexported fields
}

func NewTokensController 

func NewTokensController(baseController baseController) *TokensController

func (*TokensController) CreateToken 

func (t *TokensController) CreateToken(
	ctx context.Context,
	publicKey string,
	request *models.CreateTokenRequest,
	idempotencyKey *string) (
	https.ApiResponse[models.GetTokenResponse],
	error)

TODO: type endpoint description here

func (*TokensController) GetToken 

func (t *TokensController) GetToken(
	ctx context.Context,
	id string,
	publicKey string) (
	https.ApiResponse[models.GetTokenResponse],
	error)

Gets a token from its id

type TransactionsController 

type TransactionsController struct {
	// contains filtered or unexported fields
}

func NewTransactionsController 

func NewTransactionsController(baseController baseController) *TransactionsController

func (*TransactionsController) GetTransaction 

func (t *TransactionsController) GetTransaction(ctx context.Context, transactionId string) (
	https.ApiResponse[models.GetTransactionResponseInterface],
	error)

TODO: type endpoint description here

type TransfersController 

type TransfersController struct {
	// contains filtered or unexported fields
}

func NewTransfersController 

func NewTransfersController(baseController baseController) *TransfersController

func (*TransfersController) CreateTransfer 

func (t *TransfersController) CreateTransfer(ctx context.Context, request *models.CreateTransfer) (
	https.ApiResponse[models.GetTransfer],
	error)

TODO: type endpoint description here

func (*TransfersController) GetTransferById 

func (t *TransfersController) GetTransferById(ctx context.Context, transferId string) (
	https.ApiResponse[models.GetTransfer],
	error)

TODO: type endpoint description here

func (*TransfersController) GetTransfers 

func (t *TransfersController) GetTransfers(ctx context.Context) (
	https.ApiResponse[models.ListTransfers],
	error)

Gets all transfers

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.