orders_pkg

package

v0.0.0-...-2e3d4c0 Latest Latest Go to latest Published: Jun 22, 2023 License: MIT Imports: 6 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 ORDERS
type ORDERS_IMPL
- func NewORDERS(config configuration_pkg.CONFIGURATION) *ORDERS_IMPL

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ORDERS ¶

type ORDERS interface {
	GetOrders(*int64, *int64, *string, *string, *time.Time, *time.Time, *string) (*models_pkg.ListOrderResponse, error)

	CreateOrder(*models_pkg.CreateOrderRequest, *string) (*models_pkg.GetOrderResponse, error)

	CreateOrderItem(string, *models_pkg.CreateOrderItemRequest, *string) (*models_pkg.GetOrderItemResponse, error)

	GetOrderItem(string, string) (*models_pkg.GetOrderItemResponse, error)

	DeleteOrderItem(string, string, *string) (*models_pkg.GetOrderItemResponse, error)

	UpdateOrderMetadata(string, *models_pkg.UpdateMetadataRequest, *string) (*models_pkg.GetOrderResponse, error)

	DeleteAllOrderItems(string, *string) (*models_pkg.GetOrderResponse, error)

	UpdateOrderItem(string, string, *models_pkg.UpdateOrderItemRequest, *string) (*models_pkg.GetOrderItemResponse, error)

	CloseOrder(string, *models_pkg.UpdateOrderStatusRequest, *string) (*models_pkg.GetOrderResponse, error)

	GetOrder(string) (*models_pkg.GetOrderResponse, error)
}

* Interface for the ORDERS_IMPL

type ORDERS_IMPL ¶

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

* Client structure as interface implementation

func NewORDERS ¶

func NewORDERS(config configuration_pkg.CONFIGURATION) *ORDERS_IMPL

* Factory for the ORDERS interaface returning ORDERS_IMPL

func (*ORDERS_IMPL) CloseOrder ¶

func (me *ORDERS_IMPL) CloseOrder(
	id string,
	body *models_pkg.UpdateOrderStatusRequest,
	idempotencyKey *string) (*models_pkg.GetOrderResponse, error)

*

CloseOrder
@param string id parameter: Required
@param *models_pkg.UpdateOrderStatusRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetOrderResponse response from the API call

func (*ORDERS_IMPL) CreateOrder ¶

func (me *ORDERS_IMPL) CreateOrder(
	body *models_pkg.CreateOrderRequest,
	idempotencyKey *string) (*models_pkg.GetOrderResponse, error)

*

Creates a new Order
@param *models_pkg.CreateOrderRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetOrderResponse response from the API call

func (*ORDERS_IMPL) CreateOrderItem ¶

func (me *ORDERS_IMPL) CreateOrderItem(
	orderId string,
	body *models_pkg.CreateOrderItemRequest,
	idempotencyKey *string) (*models_pkg.GetOrderItemResponse, error)

*

CreateOrderItem
@param string orderId parameter: Required
@param *models_pkg.CreateOrderItemRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetOrderItemResponse response from the API call

func (*ORDERS_IMPL) DeleteAllOrderItems ¶

func (me *ORDERS_IMPL) DeleteAllOrderItems(
	orderId string,
	idempotencyKey *string) (*models_pkg.GetOrderResponse, error)

*

DeleteAllOrderItems
@param string orderId parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetOrderResponse response from the API call

func (*ORDERS_IMPL) DeleteOrderItem ¶

func (me *ORDERS_IMPL) DeleteOrderItem(
	orderId string,
	itemId string,
	idempotencyKey *string) (*models_pkg.GetOrderItemResponse, error)

*

DeleteOrderItem
@param string orderId parameter: Required
@param string itemId parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetOrderItemResponse response from the API call

func (*ORDERS_IMPL) GetOrder ¶

func (me *ORDERS_IMPL) GetOrder(
	orderId string) (*models_pkg.GetOrderResponse, error)

*

Gets an order
@param string orderId parameter: Required
@return Returns the *models_pkg.GetOrderResponse response from the API call

func (*ORDERS_IMPL) GetOrderItem ¶

func (me *ORDERS_IMPL) GetOrderItem(
	orderId string,
	itemId string) (*models_pkg.GetOrderItemResponse, error)

*

GetOrderItem
@param string orderId parameter: Required
@param string itemId parameter: Required
@return Returns the *models_pkg.GetOrderItemResponse response from the API call

func (*ORDERS_IMPL) GetOrders ¶

func (me *ORDERS_IMPL) GetOrders(
	page *int64,
	size *int64,
	code *string,
	status *string,
	createdSince *time.Time,
	createdUntil *time.Time,
	customerId *string) (*models_pkg.ListOrderResponse, error)

*

Gets all orders
@param *int64 page parameter: Optional
@param *int64 size parameter: Optional
@param *string code parameter: Optional
@param *string status parameter: Optional
@param *time.Time createdSince parameter: Optional
@param *time.Time createdUntil parameter: Optional
@param *string customerId parameter: Optional
@return Returns the *models_pkg.ListOrderResponse response from the API call

func (*ORDERS_IMPL) UpdateOrderItem ¶

func (me *ORDERS_IMPL) UpdateOrderItem(
	orderId string,
	itemId string,
	body *models_pkg.UpdateOrderItemRequest,
	idempotencyKey *string) (*models_pkg.GetOrderItemResponse, error)

*

UpdateOrderItem
@param string orderId parameter: Required
@param string itemId parameter: Required
@param *models_pkg.UpdateOrderItemRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetOrderItemResponse response from the API call

func (*ORDERS_IMPL) UpdateOrderMetadata ¶

func (me *ORDERS_IMPL) UpdateOrderMetadata(
	orderId string,
	body *models_pkg.UpdateMetadataRequest,
	idempotencyKey *string) (*models_pkg.GetOrderResponse, error)

*

Updates the metadata from an order
@param string orderId parameter: Required
@param *models_pkg.UpdateMetadataRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.GetOrderResponse 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