PolarExpress.Services.CustomFieldsService (polar_express v0.1.5)

Copy Markdown View Source

Custom-fields

CustomFields API operations.

Summary

Functions

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

@spec create_custom_field(PolarExpress.Client.t(), map(), keyword()) ::
  {:ok, PolarExpress.Schemas.CustomField.t()} | {:error, PolarExpress.Error.t()}

Create Custom Field

Create a custom field.

Scopes: custom_fields:write

See PolarExpress.Params.CustomFieldsCreateCustomFieldParams for parameter details.

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

@spec delete_custom_field(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, PolarExpress.Error.t()}

Delete Custom Field

Delete a custom field.

Scopes: custom_fields:write

See PolarExpress.Params.CustomFieldsDeleteCustomFieldParams for parameter details.

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

@spec get_custom_field(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
  {:ok, PolarExpress.Schemas.CustomField.t()} | {:error, PolarExpress.Error.t()}

Get Custom Field

Get a custom field by ID.

Scopes: custom_fields:read custom_fields:write

See PolarExpress.Params.CustomFieldsGetCustomFieldParams for parameter details.

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

@spec list_custom_fields(PolarExpress.Client.t(), map(), keyword()) ::
  {:ok, PolarExpress.ListObject.t()} | {:error, PolarExpress.Error.t()}

List Custom Fields

List custom fields.

Scopes: custom_fields:read custom_fields:write

See PolarExpress.Params.CustomFieldsListCustomFieldsParams for parameter details.

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

@spec update_custom_field(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
  {:ok, PolarExpress.Schemas.CustomField.t()} | {:error, PolarExpress.Error.t()}

Update Custom Field

Update a custom field.

Scopes: custom_fields:write

See PolarExpress.Params.CustomFieldsUpdateCustomFieldParams for parameter details.