Polarex.CustomFields (Polarex v0.2.3)

View Source

Provides API endpoints related to custom fields

Summary

Functions

custom_fields_create(body, opts \\ [])

Create Custom Field

Create a custom field.

Scopes: custom_fields:write

custom_fields_delete(id, opts \\ [])

@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

custom_fields_get(id, opts \\ [])

Get Custom Field

Get a custom field by ID.

Scopes: custom_fields:read custom_fields:write

custom_fields_list(opts \\ [])

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

custom_fields_update(id, body, opts \\ [])

Update Custom Field

Update a custom field.

Scopes: custom_fields:write