Search documentation of polar_express

# PolarExpress.Services.CheckoutLinksService (polar_express v0.1.5)

Copy Markdown View Source

Checkout-links

CheckoutLinks API operations.

## Summary

### Functions

create_checkout_link(client, params \\ %{}, opts \\ [])

Create Checkout Link

delete_checkout_link(client, id, params \\ %{}, opts \\ [])

Delete Checkout Link

get_checkout_link(client, id, params \\ %{}, opts \\ [])

Get Checkout Link

list_checkout_links(client, params \\ %{}, opts \\ [])

List Checkout Links

update_checkout_link(client, id, params \\ %{}, opts \\ [])

Update Checkout Link

## Functions

# create_checkout_link(client, params \\ %{}, opts \\ [])

    @spec create_checkout_link(PolarExpress.Client.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.CheckoutLink.t()}
      | {:error, PolarExpress.Error.t()}

Create Checkout Link

Create a checkout link.

Scopes: `checkout_links:write`

See `PolarExpress.Params.CheckoutLinksCreateCheckoutLinkParams` for parameter details.

# delete_checkout_link(client, id, params \\ %{}, opts \\ [])

    @spec delete_checkout_link(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, PolarExpress.Error.t()}

Delete Checkout Link

Delete a checkout link.

Scopes: `checkout_links:write`

See `PolarExpress.Params.CheckoutLinksDeleteCheckoutLinkParams` for parameter details.

# get_checkout_link(client, id, params \\ %{}, opts \\ [])

    @spec get_checkout_link(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.CheckoutLink.t()}
      | {:error, PolarExpress.Error.t()}

Get Checkout Link

Get a checkout link by ID.

Scopes: `checkout_links:read` `checkout_links:write`

See `PolarExpress.Params.CheckoutLinksGetCheckoutLinkParams` for parameter details.

# list_checkout_links(client, params \\ %{}, opts \\ [])

    @spec list_checkout_links(PolarExpress.Client.t(), map(), keyword()) ::
      {:ok, PolarExpress.ListObject.t()} | {:error, PolarExpress.Error.t()}

List Checkout Links

List checkout links.

Scopes: `checkout_links:read` `checkout_links:write`

See `PolarExpress.Params.CheckoutLinksListCheckoutLinksParams` for parameter details.

# update_checkout_link(client, id, params \\ %{}, opts \\ [])

    @spec update_checkout_link(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.CheckoutLink.t()}
      | {:error, PolarExpress.Error.t()}

Update Checkout Link

Update a checkout link.

Scopes: `checkout_links:write`

See `PolarExpress.Params.CheckoutLinksUpdateCheckoutLinkParams` for parameter details.