DodoPayments.Products.Images (dodo_payments v0.1.0)

Copy Markdown View Source

Product image upload/update operations.

Summary

Types

update_params()

Parameters for product_images_update. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/products/images.ts declaration ImageUpdateParams.

Functions

update(client, id)

Calls Dodo operation product_images_update (PUT /products/{id}/images). Required parameters: none.

update(client, id, opts)

Calls Dodo operation product_images_update (PUT /products/{id}/images). Required parameters: none.

update(client, id, params, opts)

Calls Dodo operation product_images_update (PUT /products/{id}/images). Required parameters: none.

Types

update_params()

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

Parameters for product_images_update. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/products/images.ts declaration ImageUpdateParams.

Functions

update(client, id)

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

Calls Dodo operation product_images_update (PUT /products/{id}/images). Required parameters: none.

Calls the operation with an empty parameter map.

update(client, id, opts)

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

Calls Dodo operation product_images_update (PUT /products/{id}/images). Required parameters: none.

Pass a map for Dodo parameters or a keyword list for request-local options.

update(client, id, params, opts)

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

Calls Dodo operation product_images_update (PUT /products/{id}/images). Required parameters: none.

Accepts both a Dodo parameter map and request-local options.