Polarex.Products (Polarex v0.2.3)
View SourceProvides API endpoints related to products
Summary
Functions
@spec products_create( Polarex.ProductCreate.t(), keyword() ) :: {:ok, Polarex.Product.t()} | {:error, Polarex.HTTPValidationError.t()}
Create Product
Create a product.
Scopes: products:write
@spec products_get( String.t(), keyword() ) :: {:ok, Polarex.Product.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Product
Get a product by ID.
Scopes: products:read
products:write
@spec products_list(keyword()) :: {:ok, Polarex.ListResourceProduct.t()} | {:error, Polarex.HTTPValidationError.t()}
List Products
List products.
Scopes: products:read
products:write
Options
id
: Filter by product ID.organization_id
: Filter by organization ID.query
: Filter by product name.is_archived
: Filter on archived products.is_recurring
: Filter on recurring products. Iftrue
, only subscriptions tiers are returned. Iffalse
, only one-time purchase products are returned.benefit_id
: Filter products granting specific benefit.page
: Page number, defaults to 1.limit
: Size of a page, defaults to 10. Maximum is 100.sorting
: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign-
before the criteria name to sort by descending order.
@spec products_update(String.t(), Polarex.ProductUpdate.t(), keyword()) :: {:ok, Polarex.Product.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.NotPermitted.t() | Polarex.ResourceNotFound.t()}
Update Product
Update a product.
Scopes: products:write
@spec products_update_benefits( String.t(), Polarex.ProductBenefitsUpdate.t(), keyword() ) :: {:ok, Polarex.Product.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.NotPermitted.t() | Polarex.ResourceNotFound.t()}
Update Product Benefits
Update benefits granted by a product.
Scopes: products:write