Polarex.CustomFields (Polarex v0.2.3)
View SourceProvides API endpoints related to custom fields
Summary
Functions
Create Custom Field
Delete Custom Field
Get Custom Field
List Custom Fields
Update Custom Field
Functions
@spec custom_fields_create( Polarex.CustomFieldCreateCheckbox.t() | Polarex.CustomFieldCreateDate.t() | Polarex.CustomFieldCreateNumber.t() | Polarex.CustomFieldCreateSelect.t() | Polarex.CustomFieldCreateText.t(), keyword() ) :: {:ok, Polarex.CustomFieldCheckbox.t() | Polarex.CustomFieldDate.t() | Polarex.CustomFieldNumber.t() | Polarex.CustomFieldSelect.t() | Polarex.CustomFieldText.t()} | {:error, Polarex.HTTPValidationError.t()}
Create Custom Field
Create a custom field.
Scopes: custom_fields:write
@spec custom_fields_delete( String.t(), keyword() ) :: :ok | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Delete Custom Field
Delete a custom field.
Scopes: custom_fields:write
@spec custom_fields_get( String.t(), keyword() ) :: {:ok, Polarex.CustomFieldCheckbox.t() | Polarex.CustomFieldDate.t() | Polarex.CustomFieldNumber.t() | Polarex.CustomFieldSelect.t() | Polarex.CustomFieldText.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Custom Field
Get a custom field by ID.
Scopes: custom_fields:read
custom_fields:write
@spec custom_fields_list(keyword()) :: {:ok, Polarex.ListResourceCustomField.t()} | {:error, Polarex.HTTPValidationError.t()}
List Custom Fields
List custom fields.
Scopes: custom_fields:read
custom_fields:write
Options
organization_id
: Filter by organization ID.query
: Filter by custom field name or slug.type
: Filter by custom field type.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 custom_fields_update( String.t(), Polarex.CustomFieldUpdateCheckbox.t() | Polarex.CustomFieldUpdateDate.t() | Polarex.CustomFieldUpdateNumber.t() | Polarex.CustomFieldUpdateSelect.t() | Polarex.CustomFieldUpdateText.t(), keyword() ) :: {:ok, Polarex.CustomFieldCheckbox.t() | Polarex.CustomFieldDate.t() | Polarex.CustomFieldNumber.t() | Polarex.CustomFieldSelect.t() | Polarex.CustomFieldText.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Update Custom Field
Update a custom field.
Scopes: custom_fields:write