MillionSend.ContactProperties (MillionSend v0.4.0)

Contact property definitions. Input maps are sent as given: create/2 accepts key, type (:string | :number) and fallback_value; update/3 accepts fallback_value (nil clears it).

MillionSend.ContactProperties.create(%{key: "plan", type: :string, fallback_value: "free"})

Summary

Functions

create(client \\ MillionSend.client(), params)

POST /contact-properties — a duplicate key is a 409.

get(client \\ MillionSend.client(), id)

GET /contact-properties/:id

list()

GET /contact-properties — accepts limit:, after:, before:.

list(client)

list(client, opts)

remove(client \\ MillionSend.client(), id)

DELETE /contact-properties/:id

update(client \\ MillionSend.client(), id, params)

PATCH /contact-properties/:id — fallback_value (nil clears it).

Functions

create(client \\ MillionSend.client(), params)

@spec create(MillionSend.Client.t(), map()) ::
  {:ok, MillionSend.ContactProperties.ContactProperty.t()}
  | {:error, MillionSend.Error.t()}

POST /contact-properties — a duplicate key is a 409.

get(client \\ MillionSend.client(), id)

@spec get(MillionSend.Client.t(), String.t()) ::
  {:ok, MillionSend.ContactProperties.ContactProperty.t()}
  | {:error, MillionSend.Error.t()}

GET /contact-properties/:id

list()

GET /contact-properties — accepts limit:, after:, before:.

list(client)

@spec list(MillionSend.Client.t() | keyword()) ::
  {:ok, MillionSend.List.t()} | {:error, MillionSend.Error.t()}

list(client, opts)

@spec list(
  MillionSend.Client.t(),
  keyword()
) :: {:ok, MillionSend.List.t()} | {:error, MillionSend.Error.t()}

remove(client \\ MillionSend.client(), id)

@spec remove(MillionSend.Client.t(), String.t()) ::
  {:ok, MillionSend.ContactProperties.ContactProperty.t()}
  | {:error, MillionSend.Error.t()}

DELETE /contact-properties/:id

update(client \\ MillionSend.client(), id, params)

@spec update(MillionSend.Client.t(), String.t(), map()) ::
  {:ok, MillionSend.ContactProperties.ContactProperty.t()}
  | {:error, MillionSend.Error.t()}

PATCH /contact-properties/:id — fallback_value (nil clears it).