PolarExpress.Services.OrganizationsService (polar_express v0.1.5)

Copy Markdown View Source

Organizations

Organizations API operations.

Summary

Functions

create_organization(client, params \\ %{}, opts \\ [])

@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.

get_organization(client, id, params \\ %{}, opts \\ [])

@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.

list_organizations(client, params \\ %{}, opts \\ [])

@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.

update_organization(client, id, params \\ %{}, opts \\ [])

@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.