Synctera.PaymentSchedules (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'PaymentSchedules' endpoints.

Code generated by scripts/generate.py from the Synctera OpenAPI spec. Do not edit by hand — re-run mix generate (or python3 scripts/generate.py) to regenerate.

Summary

Functions

Create a payment schedule — Create a payment schedule

Like create_payment_schedule/2 but returns the value directly and raises on error.

List payment schedules — Get paginated list of payment schedules

Like list_payment_schedules/2 but returns the value directly and raises on error.

List payments — Get paginated list of payments

Like list_payments/2 but returns the value directly and raises on error.

Update a payment schedule — Update a payment schedule

Like patch_payment_schedule/3 but returns the value directly and raises on error.

Functions

create_payment_schedule(client, opts \\ [])

@spec create_payment_schedule(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Create a payment schedule — Create a payment schedule

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

create_payment_schedule!(client, opts)

@spec create_payment_schedule!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like create_payment_schedule/2 but returns the value directly and raises on error.

list_payment_schedules(client, opts \\ [])

@spec list_payment_schedules(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List payment schedules — Get paginated list of payment schedules

Options

Query options: :limit, :page_token, :id, :account_id, :customer_id

  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

list_payment_schedules!(client, opts)

@spec list_payment_schedules!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_payment_schedules/2 but returns the value directly and raises on error.

list_payments(client, opts \\ [])

@spec list_payments(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List payments — Get paginated list of payments

Options

Query options: :limit, :page_token, :id, :schedule_id, :account_id, :customer_id

  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

list_payments!(client, opts)

@spec list_payments!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_payments/2 but returns the value directly and raises on error.

patch_payment_schedule(client, payment_schedule_id, opts \\ [])

@spec patch_payment_schedule(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Update a payment schedule — Update a payment schedule

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

patch_payment_schedule!(client, payment_schedule_id, opts)

@spec patch_payment_schedule!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like patch_payment_schedule/3 but returns the value directly and raises on error.