Thinkific.Api.Orders (Thinkific API SDK v0.1.3)
API calls for all endpoints tagged Orders.
Link to this section Summary
Functions
getOrderByID Returns the orders identified by the provided id.
getOrders Retrieve a list of Orders
Link to this section Functions
Link to this function
get_order_by_id(connection, id, opts \\ [])
Specs
get_order_by_id(Tesla.Env.client(), float(), keyword()) :: {:ok, Thinkific.Model.OrderResponse.t()} | {:error, Tesla.Env.t()}
getOrderByID Returns the orders identified by the provided id.
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): ID of the Orders in the form of an integer.
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
get_orders(connection, opts \\ [])
Specs
get_orders(Tesla.Env.client(), keyword()) :: {:ok, Thinkific.Model.GetOrdersResponse.t()} | {:error, Tesla.Env.t()}
getOrders Retrieve a list of Orders
Parameters
- connection (Thinkific.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :page (float()): The page within the collection to fetch.
- :limit (float()): The number of items to be returned.
Returns
} on success {:error, info} on failure