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

Executes a BatchQuery against /0/DataService/json/SyncReply/BatchQuery.

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

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

Executes a custom Creatio REST web service (/0/rest/{service_name}/{endpoint}).

Examples

{:ok, response} =
  Creatio.DataService.custom_service(client, "CustomService", "CustomEndpoint", %{"param" => "value"})

@spec custom_service!(
  Creatio.Client.t() | Req.Request.t(),
  String.t(),
  String.t(),
  any(),
  keyword()
) :: any()

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

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

Executes a DeleteQuery against /0/DataService/json/SyncReply/DeleteQuery.

Returns {:error, %Creatio.Error{status: 403, code: "ReadOnlyMode"}} if the client is in read-only mode.

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

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

Executes a generic DataService query against /0/DataService/json/SyncReply/{action}.

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

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

Executes an InsertQuery against /0/DataService/json/SyncReply/InsertQuery.

Returns {:error, %Creatio.Error{status: 403, code: "ReadOnlyMode"}} if the client is in read-only mode.

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

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

Executes a SelectQuery against /0/DataService/json/SyncReply/SelectQuery.

Examples

query = %{
  "RootSchemaName" => "Account",
  "columns" => %{
    "items" => %{
      "Name" => %{
        "expression" => %{"columnPath" => "Name"}
      }
    }
  }
}

{:ok, result} = Creatio.DataService.select_query(client, query)

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

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

Executes an UpdateQuery against /0/DataService/json/SyncReply/UpdateQuery.

Returns {:error, %Creatio.Error{status: 403, code: "ReadOnlyMode"}} if the client is in read-only mode.

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