Polarex.Products (Polarex v0.2.0)

View Source

Provides API endpoints related to products

Summary

Functions

products_create(body, opts \\ [])

@spec products_create(
  Polarex.ProductCreate.t(),
  keyword()
) :: {:ok, Polarex.Product.t()} | {:error, Polarex.HTTPValidationError.t()}

Create Product

Create a product.

Scopes: products:write

products_get(id, opts \\ [])

@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

products_list(opts \\ [])

@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. If true, only subscriptions tiers are returned. If false, 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.

products_update(id, body, opts \\ [])

Update Product

Update a product.

Scopes: products:write

products_update_benefits(id, body, opts \\ [])

Update Product Benefits

Update benefits granted by a product.

Scopes: products:write