DodoPayments.ProductCollections.Groups.Items (dodo_payments v0.1.0)

Items within a product-collection group.

Summary

Types

Parameters for collection_group_items_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/product-collections/groups/items.ts declaration ItemCreateParams.

update_params()

Parameters for collection_group_items_update. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/product-collections/groups/items.ts declaration ItemUpdateParams.

Functions

create(client, id, group_id, params)

Calls Dodo operation collection_group_items_create (POST /product-collections/{id}/groups/{group_id}/items). Required parameters: :products.

create(client, id, group_id, params, opts)

Calls Dodo operation collection_group_items_create (POST /product-collections/{id}/groups/{group_id}/items). Required parameters: :products.

delete(client, id, group_id, item_id, opts \\ [])

Calls Dodo operation collection_group_items_delete (DELETE /product-collections/{id}/groups/{group_id}/items/{item_id}). Required parameters: none.

update(client, id, group_id, item_id, params)

Calls Dodo operation collection_group_items_update (PATCH /product-collections/{id}/groups/{group_id}/items/{item_id}). Required parameters: :status.

update(client, id, group_id, item_id, params, opts)

Calls Dodo operation collection_group_items_update (PATCH /product-collections/{id}/groups/{group_id}/items/{item_id}). Required parameters: :status.

Types

create_params()

@type create_params() ::
  %{
    :products => [DodoPayments.RequestTypes.collection_group_product()],
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

update_params()

@type update_params() ::
  %{
    :status => boolean(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Functions

create(client, id, group_id, params)

@spec create(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  create_params()
) ::
  {:ok, [DodoPayments.ProductCollectionProduct.t()]} | {:error, Exception.t()}

Calls Dodo operation collection_group_items_create (POST /product-collections/{id}/groups/{group_id}/items). Required parameters: :products.

API parameters must be supplied as a map.

create(client, id, group_id, params, opts)

@spec create(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  create_params(),
  keyword()
) ::
  {:ok,
   [DodoPayments.ProductCollectionProduct.t()]
   | DodoPayments.Response.t([DodoPayments.ProductCollectionProduct.t()])}
  | {:error, Exception.t()}

Calls Dodo operation collection_group_items_create (POST /product-collections/{id}/groups/{group_id}/items). Required parameters: :products.

The final argument contains request-local options.

delete(client, id, group_id, item_id, opts \\ [])

@spec delete(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  String.t() | integer(),
  keyword()
) :: {:ok, nil | DodoPayments.Response.t(nil)} | {:error, Exception.t()}

Calls Dodo operation collection_group_items_delete (DELETE /product-collections/{id}/groups/{group_id}/items/{item_id}). Required parameters: none.

Options are request-local.

update(client, id, group_id, item_id, params)

@spec update(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  String.t() | integer(),
  update_params()
) :: {:ok, nil} | {:error, Exception.t()}

Calls Dodo operation collection_group_items_update (PATCH /product-collections/{id}/groups/{group_id}/items/{item_id}). Required parameters: :status.

API parameters must be supplied as a map.

update(client, id, group_id, item_id, params, opts)

@spec update(
  DodoPayments.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  String.t() | integer(),
  update_params(),
  keyword()
) :: {:ok, nil | DodoPayments.Response.t(nil)} | {:error, Exception.t()}

Calls Dodo operation collection_group_items_update (PATCH /product-collections/{id}/groups/{group_id}/items/{item_id}). Required parameters: :status.

The final argument contains request-local options.