Polarex.Organizations (Polarex v0.1.0)
View SourceProvides API endpoints related to organizations
Summary
Functions
Get Organization
Create Organization
Get Organization
List Organizations
Update Organization
Functions
@spec customer_portal_organizations_get( String.t(), keyword() ) :: {:ok, Polarex.CustomerOrganization.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Organization
Get a customer portal's organization by slug.
@spec organizations_create( Polarex.OrganizationCreate.t(), keyword() ) :: {:ok, Polarex.Organization.t()} | {:error, Polarex.HTTPValidationError.t()}
Create Organization
Create an organization.
Scopes: organizations:write
@spec organizations_get( String.t(), keyword() ) :: {:ok, Polarex.Organization.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Organization
Get an organization by ID.
Scopes: organizations:read
organizations:write
@spec organizations_list(keyword()) :: {:ok, Polarex.ListResourceOrganization.t()} | {:error, Polarex.HTTPValidationError.t()}
List Organizations
List organizations.
Scopes: organizations:read
organizations:write
Options
slug
: Filter by slug.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 organizations_update(String.t(), Polarex.OrganizationUpdate.t(), keyword()) :: {:ok, Polarex.Organization.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.NotPermitted.t() | Polarex.ResourceNotFound.t()}
Update Organization
Update an organization.
Scopes: organizations:write