customers_pkg

package

v0.0.0-...-2e3d4c0 Latest Latest Go to latest Published: Jun 22, 2023 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pagarme/pagarme-core-api-go

Links

Open Source Insights

Documentation ¶

Index ¶

type CUSTOMERS
type CUSTOMERS_IMPL
- func NewCUSTOMERS(config configuration_pkg.CONFIGURATION) *CUSTOMERS_IMPL

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CUSTOMERS ¶

type CUSTOMERS interface {
	DeleteCard(string, string, *string) (*models_pkg.GetCardResponse, error)

	UpdateAddress(string, string, *models_pkg.UpdateAddressRequest, *string) (*models_pkg.GetAddressResponse, error)

	GetAddress(string, string) (*models_pkg.GetAddressResponse, error)

	GetAccessTokens(string, *int64, *int64) (*models_pkg.ListAccessTokensResponse, error)

	UpdateCustomer(string, *models_pkg.UpdateCustomerRequest, *string) (*models_pkg.GetCustomerResponse, error)

	RenewCard(string, string, *string) (*models_pkg.GetCardResponse, error)

	GetCustomers(*string, *string, *int64, *int64, *string, *string) (*models_pkg.ListCustomersResponse, error)

	DeleteAccessTokens(string) (*models_pkg.ListAccessTokensResponse, error)

	GetCustomer(string) (*models_pkg.GetCustomerResponse, error)

	UpdateCard(string, string, *models_pkg.UpdateCardRequest, *string) (*models_pkg.GetCardResponse, error)

	DeleteAddress(string, string, *string) (*models_pkg.GetAddressResponse, error)

	CreateAccessToken(string, *models_pkg.CreateAccessTokenRequest, *string) (*models_pkg.GetAccessTokenResponse, error)

	CreateAddress(string, *models_pkg.CreateAddressRequest, *string) (*models_pkg.GetAddressResponse, error)

	GetCards(string, *int64, *int64) (*models_pkg.ListCardsResponse, error)

	UpdateCustomerMetadata(string, *models_pkg.UpdateMetadataRequest, *string) (*models_pkg.GetCustomerResponse, error)

	GetCard(string, string) (*models_pkg.GetCardResponse, error)

	DeleteAccessToken(string, string, *string) (*models_pkg.GetAccessTokenResponse, error)

	GetAccessToken(string, string) (*models_pkg.GetAccessTokenResponse, error)

	GetAddresses(string, *int64, *int64) (*models_pkg.ListAddressesResponse, error)

	CreateCustomer(*models_pkg.CreateCustomerRequest, *string) (*models_pkg.GetCustomerResponse, error)

	CreateCard(string, *models_pkg.CreateCardRequest, *string) (*models_pkg.GetCardResponse, error)
}

* Interface for the CUSTOMERS_IMPL

type CUSTOMERS_IMPL ¶

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

* Client structure as interface implementation

func NewCUSTOMERS ¶

func NewCUSTOMERS(config configuration_pkg.CONFIGURATION) *CUSTOMERS_IMPL

* Factory for the CUSTOMERS interaface returning CUSTOMERS_IMPL

func (*CUSTOMERS_IMPL) CreateAccessToken ¶

func (me *CUSTOMERS_IMPL) CreateAccessToken(
	customerId string,
	body *models_pkg.CreateAccessTokenRequest,
	idempotencyKey *string) (*models_pkg.GetAccessTokenResponse, error)

*

Creates a access token for a customer
@param string customerId parameter: Required
@param *models_pkg.CreateAccessTokenRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetAccessTokenResponse response from the API call

func (*CUSTOMERS_IMPL) CreateAddress ¶

func (me *CUSTOMERS_IMPL) CreateAddress(
	customerId string,
	body *models_pkg.CreateAddressRequest,
	idempotencyKey *string) (*models_pkg.GetAddressResponse, error)

*

Creates a new address for a customer
@param string customerId parameter: Required
@param *models_pkg.CreateAddressRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetAddressResponse response from the API call

func (*CUSTOMERS_IMPL) CreateCard ¶

func (me *CUSTOMERS_IMPL) CreateCard(
	customerId string,
	body *models_pkg.CreateCardRequest,
	idempotencyKey *string) (*models_pkg.GetCardResponse, error)

*

Creates a new card for a customer
@param string customerId parameter: Required
@param *models_pkg.CreateCardRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetCardResponse response from the API call

func (*CUSTOMERS_IMPL) CreateCustomer ¶

func (me *CUSTOMERS_IMPL) CreateCustomer(
	body *models_pkg.CreateCustomerRequest,
	idempotencyKey *string) (*models_pkg.GetCustomerResponse, error)

*

Creates a new customer
@param *models_pkg.CreateCustomerRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetCustomerResponse response from the API call

func (*CUSTOMERS_IMPL) DeleteAccessToken ¶

func (me *CUSTOMERS_IMPL) DeleteAccessToken(
	customerId string,
	tokenId string,
	idempotencyKey *string) (*models_pkg.GetAccessTokenResponse, error)

*

Delete a customer's access token
@param string customerId parameter: Required
@param string tokenId parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetAccessTokenResponse response from the API call

func (*CUSTOMERS_IMPL) DeleteAccessTokens ¶

func (me *CUSTOMERS_IMPL) DeleteAccessTokens(
	customerId string) (*models_pkg.ListAccessTokensResponse, error)

*

Delete a Customer's access tokens
@param string customerId parameter: Required
@return Returns the *models_pkg.ListAccessTokensResponse response from the API call

func (*CUSTOMERS_IMPL) DeleteAddress ¶

func (me *CUSTOMERS_IMPL) DeleteAddress(
	customerId string,
	addressId string,
	idempotencyKey *string) (*models_pkg.GetAddressResponse, error)

*

Delete a Customer's address
@param string customerId parameter: Required
@param string addressId parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetAddressResponse response from the API call

func (*CUSTOMERS_IMPL) DeleteCard ¶

func (me *CUSTOMERS_IMPL) DeleteCard(
	customerId string,
	cardId string,
	idempotencyKey *string) (*models_pkg.GetCardResponse, error)

*

Delete a customer's card
@param string customerId parameter: Required
@param string cardId parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetCardResponse response from the API call

func (*CUSTOMERS_IMPL) GetAccessToken ¶

func (me *CUSTOMERS_IMPL) GetAccessToken(
	customerId string,
	tokenId string) (*models_pkg.GetAccessTokenResponse, error)

*

Get a Customer's access token
@param string customerId parameter: Required
@param string tokenId parameter: Required
@return Returns the *models_pkg.GetAccessTokenResponse response from the API call

func (*CUSTOMERS_IMPL) GetAccessTokens ¶

func (me *CUSTOMERS_IMPL) GetAccessTokens(
	customerId string,
	page *int64,
	size *int64) (*models_pkg.ListAccessTokensResponse, error)

*

Get all access tokens from a customer
@param string customerId parameter: Required
@param *int64 page parameter: Optional
@param *int64 size parameter: Optional
@return Returns the *models_pkg.ListAccessTokensResponse response from the API call

func (*CUSTOMERS_IMPL) GetAddress ¶

func (me *CUSTOMERS_IMPL) GetAddress(
	customerId string,
	addressId string) (*models_pkg.GetAddressResponse, error)

*

Get a customer's address
@param string customerId parameter: Required
@param string addressId parameter: Required
@return Returns the *models_pkg.GetAddressResponse response from the API call

func (*CUSTOMERS_IMPL) GetAddresses ¶

func (me *CUSTOMERS_IMPL) GetAddresses(
	customerId string,
	page *int64,
	size *int64) (*models_pkg.ListAddressesResponse, error)

*

Gets all adressess from a customer
@param string customerId parameter: Required
@param *int64 page parameter: Optional
@param *int64 size parameter: Optional
@return Returns the *models_pkg.ListAddressesResponse response from the API call

func (*CUSTOMERS_IMPL) GetCard ¶

func (me *CUSTOMERS_IMPL) GetCard(
	customerId string,
	cardId string) (*models_pkg.GetCardResponse, error)

*

Get a customer's card
@param string customerId parameter: Required
@param string cardId parameter: Required
@return Returns the *models_pkg.GetCardResponse response from the API call

func (*CUSTOMERS_IMPL) GetCards ¶

func (me *CUSTOMERS_IMPL) GetCards(
	customerId string,
	page *int64,
	size *int64) (*models_pkg.ListCardsResponse, error)

*

Get all cards from a customer
@param string customerId parameter: Required
@param *int64 page parameter: Optional
@param *int64 size parameter: Optional
@return Returns the *models_pkg.ListCardsResponse response from the API call

func (*CUSTOMERS_IMPL) GetCustomer ¶

func (me *CUSTOMERS_IMPL) GetCustomer(
	customerId string) (*models_pkg.GetCustomerResponse, error)

*

Get a customer
@param string customerId parameter: Required
@return Returns the *models_pkg.GetCustomerResponse response from the API call

func (*CUSTOMERS_IMPL) GetCustomers ¶

func (me *CUSTOMERS_IMPL) GetCustomers(
	name *string,
	document *string,
	page *int64,
	size *int64,
	email *string,
	code *string) (*models_pkg.ListCustomersResponse, error)

*

Get all Customers
@param *string name parameter: Optional
@param *string document parameter: Optional
@param *int64 page parameter: Optional
@param *int64 size parameter: Optional
@param *string email parameter: Optional
@param *string code parameter: Optional
@return Returns the *models_pkg.ListCustomersResponse response from the API call

func (*CUSTOMERS_IMPL) RenewCard ¶

func (me *CUSTOMERS_IMPL) RenewCard(
	customerId string,
	cardId string,
	idempotencyKey *string) (*models_pkg.GetCardResponse, error)

*

Renew a card
@param string customerId parameter: Required
@param string cardId parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetCardResponse response from the API call

func (*CUSTOMERS_IMPL) UpdateAddress ¶

func (me *CUSTOMERS_IMPL) UpdateAddress(
	customerId string,
	addressId string,
	body *models_pkg.UpdateAddressRequest,
	idempotencyKey *string) (*models_pkg.GetAddressResponse, error)

*

Updates an address
@param string customerId parameter: Required
@param string addressId parameter: Required
@param *models_pkg.UpdateAddressRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetAddressResponse response from the API call

func (*CUSTOMERS_IMPL) UpdateCard ¶

func (me *CUSTOMERS_IMPL) UpdateCard(
	customerId string,
	cardId string,
	body *models_pkg.UpdateCardRequest,
	idempotencyKey *string) (*models_pkg.GetCardResponse, error)

*

Updates a card
@param string customerId parameter: Required
@param string cardId parameter: Required
@param *models_pkg.UpdateCardRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetCardResponse response from the API call

func (*CUSTOMERS_IMPL) UpdateCustomer ¶

func (me *CUSTOMERS_IMPL) UpdateCustomer(
	customerId string,
	body *models_pkg.UpdateCustomerRequest,
	idempotencyKey *string) (*models_pkg.GetCustomerResponse, error)

*

Updates a customer
@param string customerId parameter: Required
@param *models_pkg.UpdateCustomerRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetCustomerResponse response from the API call

func (*CUSTOMERS_IMPL) UpdateCustomerMetadata ¶

func (me *CUSTOMERS_IMPL) UpdateCustomerMetadata(
	customerId string,
	body *models_pkg.UpdateMetadataRequest,
	idempotencyKey *string) (*models_pkg.GetCustomerResponse, error)

*

Updates the metadata a customer
@param string customerId parameter: Required
@param *models_pkg.UpdateMetadataRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetCustomerResponse response from the API call

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL