@spec count(Creatio.Client.t() | Req.Request.t(), String.t(), keyword()) ::
  {:ok, integer()} | {:error, Creatio.Error.t()}

Gets total count of an entity collection in OData 3.

Supports both path strategy (GET .../{Entity}Collection/$count, default) and query strategy (GET .../{Entity}Collection?/$count, Postman collection format).

Options

• :strategy - :path (default) or :query.
• :filter - Optional filter string.

Same as count/3, but raises Creatio.Error on failure.

@spec create(Creatio.Client.t() | Req.Request.t(), String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Creatio.Error.t()}

Creates an entity via OData 3 (POST .../{Entity}Collection).

Same as create/4, but raises Creatio.Error on failure.

@spec delete(Creatio.Client.t() | Req.Request.t(), String.t(), String.t(), keyword()) ::
  :ok | {:error, Creatio.Error.t()}

Deletes an entity via OData 3 (DELETE .../{Entity}Collection(guid'{id}')).

Same as delete/4, but raises Creatio.Error on failure.

@spec get(Creatio.Client.t() | Req.Request.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Creatio.Error.t()}

Gets a single entity by ID in OData 3 (GET .../{Entity}Collection(guid'{id}')).

Same as get/4, but raises Creatio.Error on failure.

@spec get_field(
  Creatio.Client.t() | Req.Request.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, any()} | {:error, Creatio.Error.t()}

Retrieves a specific field value of an entity in OData 3 (GET .../{Entity}Collection(guid'{id}')/{field_name}).

Same as get_field/5, but raises Creatio.Error on failure.

@spec get_field_value(
  Creatio.Client.t() | Req.Request.t(),
  String.t(),
  String.t(),
  String.t()
) ::
  {:ok, binary()} | {:error, Creatio.Error.t()}

Retrieves raw scalar/stream value in OData 3 (GET .../{Entity}Collection(guid'{id}')/{field_name}/$value).

Same as get_field_value/4, but raises Creatio.Error on failure.

@spec get_navigation(
  Creatio.Client.t() | Req.Request.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, any()} | {:error, Creatio.Error.t()}

Retrieves related records via a navigation property in OData 3 (GET .../{Entity}Collection(guid'{id}')/{nav_property}).

Same as get_navigation/5, but raises Creatio.Error on failure.

@spec list(
  Creatio.Client.t() | Req.Request.t(),
  String.t() | Creatio.OData.Query.t(),
  keyword() | map()
) :: {:ok, list() | map()} | {:error, Creatio.Error.t()}

Queries an OData 3 entity collection (GET .../{Entity}Collection).

Options

• :select - List or string of fields to retrieve.
• :filter - OData filter string.
• :orderby - Ordering expression or keyword list.
• :top - Maximum records to retrieve.
• :skip - Number of records to skip.
• :expand - Related entities to expand.
• :count - When true, requests inline count via $inlinecount=allpages.

Same as list/3, but raises Creatio.Error on failure.

@spec stream(
  Creatio.Client.t() | Req.Request.t(),
  String.t() | Creatio.OData.Query.t(),
  keyword()
) ::
  Enumerable.t()

Returns a lazy Stream that paginates through records of an OData 3 entity collection using $top and $skip.

Options

• :page_size - Records per request (default 100).
• :skip - Initial offset to begin streaming from (default: 0).
• :select - List or string of fields to retrieve.
• :filter - Filter expression.
• :orderby - Ordering expression.
• :expand - Relations to expand.

Same as stream/3.

@spec update(
  Creatio.Client.t() | Req.Request.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  :ok | {:ok, map()} | {:error, Creatio.Error.t()}

Updates an entity via OData 3 (PATCH .../{Entity}Collection(guid'{id}')).

Same as update/5, but raises Creatio.Error on failure.