Thinkific.Api.Products (Thinkific API SDK v0.1.3)
API calls for all endpoints tagged Products
.
Link to this section Summary
Functions
getProductByID Returns the Product identified by the provided id.
getProducts List products
getRelatedProductByProductID Returns a list of products that are related to the Product identified by the provided id.
Link to this section Functions
Link to this function
get_product_by_id(connection, id, opts \\ [])
Specs
get_product_by_id(Tesla.Env.client(), float(), keyword()) :: {:ok, Thinkific.Model.ProductResponse.t()} | {:error, Tesla.Env.t()}
getProductByID Returns the Product identified by the provided id.
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): Id of the product in the form of an integer
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
get_products(connection, opts \\ [])
Specs
get_products(Tesla.Env.client(), keyword()) :: {:ok, Thinkific.Model.GetProductsResponse.t()} | {:error, Tesla.Env.t()}
getProducts List products
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