Organizations
Organizations API operations.
Summary
Functions
@spec create_organization(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.Organization.t()} | {:error, PolarExpress.Error.t()}
Create Organization
Create an organization.
Scopes: organizations:write
See PolarExpress.Params.OrganizationsCreateOrganizationParams for parameter details.
@spec get_organization(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.Organization.t()} | {:error, PolarExpress.Error.t()}
Get Organization
Get an organization by ID.
Scopes: organizations:read organizations:write
See PolarExpress.Params.OrganizationsGetOrganizationParams for parameter details.
@spec list_organizations(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.ListObject.t()} | {:error, PolarExpress.Error.t()}
List Organizations
List organizations.
Scopes: organizations:read organizations:write
See PolarExpress.Params.OrganizationsListOrganizationsParams for parameter details.
@spec update_organization(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.Organization.t()} | {:error, PolarExpress.Error.t()}
Update Organization
Update an organization.
Scopes: organizations:write
See PolarExpress.Params.OrganizationsUpdateOrganizationParams for parameter details.