DodoPayments.Meters (dodo_payments v0.1.0)

Usage meter lifecycle operations.

Summary

Types

Parameters for meters_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/meters.ts declaration MeterCreateParams.

list_params()

Parameters for meters_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/meters.ts declaration MeterListParams.

Functions

archive(client, id, opts \\ [])

Calls Dodo operation meters_archive (DELETE /meters/{id}). Required parameters: none.

create(client, params)

Calls Dodo operation meters_create (POST /meters). Required parameters: :aggregation, :event_name, :measurement_unit, :name.

create(client, params, opts)

Calls Dodo operation meters_create (POST /meters). Required parameters: :aggregation, :event_name, :measurement_unit, :name.

list(client)

Calls Dodo operation meters_list (GET /meters). Required parameters: none. Numbered pagination is zero-based.

list(client, opts)

Calls Dodo operation meters_list (GET /meters). Required parameters: none. Numbered pagination is zero-based.

list(client, params, opts)

Calls Dodo operation meters_list (GET /meters). Required parameters: none. Numbered pagination is zero-based.

retrieve(client, id, opts \\ [])

Calls Dodo operation meters_retrieve (GET /meters/{id}). Required parameters: none.

unarchive(client, id, opts \\ [])

Calls Dodo operation meters_unarchive (POST /meters/{id}/unarchive). Required parameters: none.

Types

create_params()

@type create_params() ::
  %{
    :aggregation => DodoPayments.RequestTypes.meter_aggregation(),
    :event_name => String.t(),
    :measurement_unit => String.t(),
    :name => String.t(),
    optional(:description) => String.t(),
    optional(:filter) => DodoPayments.RequestTypes.meter_filter(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Parameters for meters_create. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/meters.ts declaration MeterCreateParams.

list_params()

@type list_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    optional(:archived) => boolean(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Parameters for meters_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/meters.ts declaration MeterListParams.

Functions

archive(client, id, opts \\ [])

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

Calls Dodo operation meters_archive (DELETE /meters/{id}). Required parameters: none.

Options are request-local.

create(client, params)

@spec create(DodoPayments.Client.t(), create_params()) ::
  {:ok, DodoPayments.Meter.t()} | {:error, Exception.t()}

Calls Dodo operation meters_create (POST /meters). Required parameters: :aggregation, :event_name, :measurement_unit, :name.

API parameters must be supplied as a map.

create(client, params, opts)

@spec create(DodoPayments.Client.t(), create_params(), keyword()) ::
  {:ok,
   DodoPayments.Meter.t() | DodoPayments.Response.t(DodoPayments.Meter.t())}
  | {:error, Exception.t()}

Calls Dodo operation meters_create (POST /meters). Required parameters: :aggregation, :event_name, :measurement_unit, :name.

The final argument contains request-local options.

list(client)

@spec list(DodoPayments.Client.t()) ::
  {:ok, DodoPayments.Page.Numbered.t(DodoPayments.Meter.t())}
  | {:error, Exception.t()}

Calls Dodo operation meters_list (GET /meters). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list(client, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil | keyword()) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.Meter.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.Meter.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation meters_list (GET /meters). Required parameters: none. Numbered pagination is zero-based.

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

list(client, params, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil, keyword()) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.Meter.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.Meter.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation meters_list (GET /meters). Required parameters: none. Numbered pagination is zero-based.

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

retrieve(client, id, opts \\ [])

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

Calls Dodo operation meters_retrieve (GET /meters/{id}). Required parameters: none.

Options are request-local.

unarchive(client, id, opts \\ [])

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

Calls Dodo operation meters_unarchive (POST /meters/{id}/unarchive). Required parameters: none.

Options are request-local.