View Source StarkInfra.CreditNote.Log (starkinfra v0.0.1)

Groups CreditNote.Log related functions

Link to this section Summary

Functions

Every time an CreditNote entity is updated, a corresponding creditnote.Log is generated for the entity. This log is never generated by the user, but it can be retrieved to check additional information on the CreditNote.

Same as get(), but it will unwrap the error tuple and raise in case of errors.

Receive a single CreditNote.Log struct previously created by the Stark Infra API by its id

Same as page(), but it will unwrap the error tuple and raise in case of errors.

Receive a list of up to 100 CreditNote.Log structs previously created in the Stark Infra API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.

Same as query(), but it will unwrap the error tuple and raise in case of errors.

Receive a stream of CreditNote.Log structs previously created in the Stark Infra API

Link to this section Types

@type t() :: %StarkInfra.CreditNote.Log{
  created: term(),
  errors: term(),
  id: term(),
  note: term(),
  type: term()
}

Link to this section Functions

Link to this function

%StarkInfra.CreditNote.Log{}

View Source (struct)

Every time an CreditNote entity is updated, a corresponding creditnote.Log is generated for the entity. This log is never generated by the user, but it can be retrieved to check additional information on the CreditNote.

attributes

Attributes:

- `:id` [string]: unique id returned when the log is created. ex: "5656565656565656"
- `:note` [CreditNote]: CreditNote entity to which the log refers to.
- `:errors` [list of strings]: list of errors linked to this CreditNote event
- `:type` [string]: type of the CreditNote event which triggered the log creation. Options: canceled, created, expired, failed, refunded, registered, sending, sent, signed, success.
- `:created` [DateTime, default nil]: creation DateTime for the CreditNote. ex: ~U[2020-3-10 10:30:0:0]
@spec get!(binary(), [
  {:user, StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil}
]) ::
  t()

Same as get(), but it will unwrap the error tuple and raise in case of errors.

@spec get(binary(), [
  {:user, StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil}
]) ::
  {:ok, [t()]} | {:error, [StarkInfra.Error.t()]}

Receive a single CreditNote.Log struct previously created by the Stark Infra API by its id

parameters-required

Parameters (required):

- `:id` [string]: struct unique id. ex: "5656565656565656"

parameters-optional

Parameters (optional):

- `:user` [Organization/Project, default nil]: Organization or Project struct returned from StarkInfra.project(). Only necessary if default project or organization has not been set in configs.

return

Return:

- CreditNote.Log struct with updated attributes
@spec page!(
  cursor: binary(),
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  note_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t()
) :: [t()]

Same as page(), but it will unwrap the error tuple and raise in case of errors.

@spec page(
  cursor: binary(),
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  note_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t()
) :: {:ok, {binary(), [Invoice.t()]}} | {:error, [StarkInfra.Error.t()]}

Receive a list of up to 100 CreditNote.Log structs previously created in the Stark Infra API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.

options

Options:

- `:cursor` [string, default nil]: cursor returned on the previous page function call
- `:limit` [integer, default 100]: maximum number of structs to be retrieved. It must be an integer between 1 and 100. ex: 50
- `:after` [Date or string, default nil] date filter for structs created only after specified date. ex: ~D[2020, 3, 10]
- `:before` [Date or string, default nil] date filter for structs created only before specified date. ex: ~D[2020, 3, 10]
- `:types` [list of strings, default []]: filter for log event types. Options: canceled, created, expired, failed, refunded, registered, sending, sent, signed, success.
- `:note_ids` [list of strings, default []]: list of CreditNote ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
- `:user` [Organization/Project, default nil]: Organization or Project struct returned from StarkInfra.project(). Only necessary if default project or organization has not been set in configs.

return

Return:

- list of CreditNote.Log structs with updated attributes
- cursor to retrieve the next page of CreditNote.Log structs
@spec query!(
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  note_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t()
) :: [t()]

Same as query(), but it will unwrap the error tuple and raise in case of errors.

@spec query(
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  note_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t()
) :: ({:cont, {:ok, [t()]}} | {:error, [StarkInfra.Error.t()]}, any() -> any())

Receive a stream of CreditNote.Log structs previously created in the Stark Infra API

options

Options:

- `:limit` [integer, default nil]: maximum number of structs to be retrieved. Unlimited if nil. ex: 35
- `:after` [Date or string, default nil] date filter for structs created only after specified date. ex: ~D[2020, 3, 10]
- `:before` [Date or string, default nil] date filter for structs created only before specified date. ex: ~D[2020, 3, 10]
- `:types` [list of strings, default []]: filter for log event types. Options: canceled, created, expired, failed, refunded, registered, sending, sent, signed, success.
- `:note_ids` [list of strings, default []]: list of CreditNote ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
- `:user` [Organization/Project, default nil]: Organization or Project struct returned from StarkInfra.project(). Only necessary if default project or organization has not been set in configs.

return

Return:

- stream of CreditNote.Log structs with updated attributes