ExTypesense.CurationSets (ExTypesense v2.3.0)

@spec delete_curation_set(curation_set_name :: String.t()) ::
  {:ok, OpenApiTypesense.CurationSetDeleteSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a curation set

Delete a specific curation set by its name

delete_curation_set(curation_set_name, opts)

(since 2.2.0)

@spec delete_curation_set(curation_set_name :: String.t(), opts :: keyword()) ::
  {:ok, OpenApiTypesense.CurationSetDeleteSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as delete_curation_set/1

Options

conn: The custom connection map or struct you passed

delete_curation_set_item(curation_set_name, item_id)

(since 2.2.0)

@spec delete_curation_set_item(
  curation_set_name :: String.t(),
  item_id :: String.t()
) ::
  {:ok, OpenApiTypesense.CurationItemDeleteSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a curation set item

Delete a specific curation item by its id

delete_curation_set_item(curation_set_name, item_id, opts)

(since 2.2.0)

@spec delete_curation_set_item(
  curation_set_name :: String.t(),
  item_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.CurationItemDeleteSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as delete_curation_set_item/2

Options

conn: The custom connection map or struct you passed

retrieve_curation_set(curation_set_name)

(since 2.2.0)

@spec retrieve_curation_set(curation_set_name :: String.t()) ::
  {:ok, OpenApiTypesense.CurationSetSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a curation set

Retrieve a specific curation set by its name

retrieve_curation_set(curation_set_name, opts)

(since 2.2.0)

@spec retrieve_curation_set(curation_set_name :: String.t(), opts :: keyword()) ::
  {:ok, OpenApiTypesense.CurationSetSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as retrieve_curation_set/1

Options

conn: The custom connection map or struct you passed

retrieve_curation_set_item(curation_set_name, item_id)

(since 2.2.0)

@spec retrieve_curation_set_item(
  curation_set_name :: String.t(),
  item_id :: String.t()
) ::
  {:ok, OpenApiTypesense.CurationItemSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a curation set item

Retrieve a specific curation item by its id

retrieve_curation_set_item(curation_set_name, item_id, opts)

(since 2.2.0)

@spec retrieve_curation_set_item(
  curation_set_name :: String.t(),
  item_id :: String.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.CurationItemSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as retrieve_curation_set_item/2

Options

conn: The custom connection map or struct you passed

retrieve_curation_set_items(curation_set_name)

(since 2.2.0)

@spec retrieve_curation_set_items(curation_set_name :: String.t()) ::
  {:ok, [OpenApiTypesense.CurationItemSchema.t()]}
  | {:error, OpenApiTypesense.ApiResponse.t()}

List items in a curation set

Retrieve all curation items in a set

retrieve_curation_set_items(curation_set_name, opts)

(since 2.2.0)

@spec retrieve_curation_set_items(curation_set_name :: String.t(), opts :: keyword()) ::
  {:ok, [OpenApiTypesense.CurationItemSchema.t()]}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as retrieve_curation_set_items/1

Options

conn: The custom connection map or struct you passed

retrieve_curation_sets()

(since 2.2.0)

@spec retrieve_curation_sets() ::
  {:ok, [OpenApiTypesense.CurationSetSchema.t()]} | :error

List all curation sets

Retrieve all curation sets

retrieve_curation_sets(opts)

(since 2.2.0)

@spec retrieve_curation_sets(opts :: keyword()) ::
  {:ok, [OpenApiTypesense.CurationSetSchema.t()]} | :error

Same as retrieve_curation_sets/0

Options

conn: The custom connection map or struct you passed

upsert_curation_set(curation_set_name, body)

(since 2.2.0)

@spec upsert_curation_set(
  curation_set_name :: String.t(),
  body :: OpenApiTypesense.CurationSetCreateSchema.t()
) ::
  {:ok, OpenApiTypesense.CurationSetSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Create or update a curation set

Create or update a curation set with the given name

Request Body

Content Types: application/json

The curation set to be created/updated

upsert_curation_set(curation_set_name, body, opts)

(since 2.2.0)

@spec upsert_curation_set(
  curation_set_name :: String.t(),
  body :: OpenApiTypesense.CurationSetCreateSchema.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.CurationSetSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as upsert_curation_set/2

Options

conn: The custom connection map or struct you passed

upsert_curation_set_item(curation_set_name, item_id, body)

(since 2.2.0)

@spec upsert_curation_set_item(
  curation_set_name :: String.t(),
  item_id :: String.t(),
  body :: OpenApiTypesense.CurationItemCreateSchema.t()
) ::
  {:ok, OpenApiTypesense.CurationItemSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Create or update a curation set item

Create or update a curation set item with the given id

Request Body

Content Types: application/json

The curation item to be created/updated

upsert_curation_set_item(curation_set_name, item_id, body, opts)

(since 2.2.0)

@spec upsert_curation_set_item(
  curation_set_name :: String.t(),
  item_id :: String.t(),
  body :: OpenApiTypesense.CurationItemCreateSchema.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.CurationItemSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Same as upsert_curation_set_item/3

Options

conn: The custom connection map or struct you passed