EPTSDK.Address (ept_sdk v2.0.1)

Summary

Functions

Creates an new %EPTSDK.Address{}} with attributes: and relationships:.

Fetches all %EPTSDK.Address{}.

Fetches a %EPTSDK.Address{} by record or by id.

Updates an existing %EPTSDK.Address with attributes: and relationships:.

Functions

Link to this function

create(client, options \\ [])

Creates an new %EPTSDK.Address{}} with attributes: and relationships:.

The options argument can also have:

  • fields:, a map of filds to return for each resource type i.e. fields: %{consumer_addresses: ["id"]}
  • include:, a list of relationship chains for the response to return i.e. include: ["consumer_addresses.merchant_account"]
Link to this function

delete(client, record, options \\ [])

Link to this function

list(client, options \\ [])

Fetches all %EPTSDK.Address{}.

The options argument can be:

  • fields, a map of filds to return for each resource type i.e. fields: %{consumer_addresses: ["id"]}
  • include, a list of relationship chains for the response to return i.e. include: ["consumer_addresses.merchant_account"]
  • sort, ... i.e. sort: ["-name"]
  • filter, ... i.e. fields: %{name: "John"}
Link to this function

show(client, id, options \\ [])

Fetches a %EPTSDK.Address{} by record or by id.

The options argument can be:

  • fields, a map of filds to return for each resource type i.e. fields: %{consumer_addresses: ["id"]}
  • include, a list of relationship chains for the response to return i.e. include: ["consumer_addresses.merchant_account"]
Link to this function

update(client, record, options \\ [])

Updates an existing %EPTSDK.Address with attributes: and relationships:.

The options argument can also have:

  • fields:, a map of filds to return for each resource type i.e. fields: %{consumer_addresses: ["id"]}
  • include:, a list of relationship chains for the response to return i.e. include: ["consumer_addresses.merchant_account"]