View Source StarkInfra.IssuingInvoice.Log (starkinfra v0.1.0)

Groups IssuingInvoice.Log related functions

Link to this section Summary

Functions

Every time an IssuingInvoice entity is updated, a corresponding IssuingInvoice.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 IssuingInvoice.

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

Receive a single IssuingInvoice.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 IssuingInvoice.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 IssuingInvoice.Log structs previously created in the Stark Infra API

Link to this section Types

@type t() :: %StarkInfra.IssuingInvoice.Log{
  created: term(),
  id: term(),
  invoice: term(),
  type: term()
}

Link to this section Functions

Link to this function

%StarkInfra.IssuingInvoice.Log{}

View Source (struct)

Every time an IssuingInvoice entity is updated, a corresponding IssuingInvoice.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 IssuingInvoice.

attributes

Attributes:

  • :id [string]: unique id returned when the log is created. ex: "5656565656565656"
  • :invoice [IssuingInvoice]: IssuingInvoice entity to which the log refers to.
  • :type [string]: type of the IssuingInvoice event which triggered the log creation. ex: "created", "credited", "expired", "overdue", "paid".
  • :created [DateTime]: creation datetime for the log. ex: ~U[2020-03-10 10:30:0:0]

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

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

parameters-required

Parameters (required):

  • :id [string]: struct unique id. ex: "5656565656565656"

options

Options:

  • :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:

  • IssuingInvoice.Log struct with updated attributes
@spec page!(
  cursor: binary(),
  ids: [binary()],
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  invoice_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: any()

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

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

Receive a list of up to 100 IssuingInvoice.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
  • :ids [list of strings, default nil]: list of IssuingInvoice ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
  • :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-03-25]
  • :before [Date or string, default nil]: date filter for structs created only before specified date. ex: ~D[2020-03-25]
  • :types [list of strings, default nil]: filter for log event types. ex: ["created", "credited", "expired", "overdue", "paid"]
  • :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 IssuingInvoice.Log structs with updated attributes
  • cursor to retrieve the next page of IssuingInvoice.Log structs
@spec query!(
  ids: [binary()],
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  invoice_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: any()

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

@spec query(
  ids: [binary()],
  limit: integer(),
  after: Date.t() | binary(),
  before: Date.t() | binary(),
  types: [binary()],
  invoice_ids: [binary()],
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: {:ok, {binary(), [t()]}} | {:error, [StarkInfra.Error.t()]}

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

options

Options:

  • :ids [list of strings, default nil]: list of IssuingInvoice ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
  • :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-03-25]
  • :before [Date or string, default nil]: date filter for structs created only before specified date. ex: ~D[2020-03-25]
  • :types [list of strings, default nil]: filter for log event types. ex: ["created", "credited", "expired", "overdue", "paid"]
  • :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 IssuingInvoice.Log structs with updated attributes