Custom-fields
CustomFields API operations.
Summary
Functions
Create Custom Field
Delete Custom Field
Get Custom Field
List Custom Fields
Update Custom Field
Functions
@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.
@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.
@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.
@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.
@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.