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

Groups PixInfraction.Log related functions

Link to this section Summary

Functions

Every time a PixInfraction entity is modified, a corresponding PixInfraction.Log is generated for the entity. This log is never generated by the user.

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

Receive a single PixInfraction.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 PixInfraction.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 infractions.

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

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

Link to this section Types

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

Link to this section Functions

Link to this function

%StarkInfra.PixInfraction.Log{}

View Source (struct)

Every time a PixInfraction entity is modified, a corresponding PixInfraction.Log is generated for the entity. This log is never generated by the user.

attributes

Attributes:

- `:id` [string]: unique id returned when the log is created. ex: "5656565656565656"
- `:created `[DateTime]: creation datetime for the log. ex: ~U[2020-3-10 10:30:0:0]
- `:type` [string]: type of the PixInfraction event which triggered the log creation. ex: "created", "failed", "delivering", "delivered", "closed", "canceled"
- `:errors` [list of strings]: list of errors linked to this PixInfraction event
- `:infraction` [PixInfraction]: PixInfraction entity to which the log refers to.

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

Receive a single PixInfraction.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:

- PixInfraction.Log struct with updated attributes
@spec page!(
  cursor: binary() | nil,
  ids: [binary()] | nil,
  limit: integer() | nil,
  after: Date.t() | binary() | nil,
  before: Date.t() | binary() | nil,
  types: [binary()] | nil,
  infraction_ids: [binary()] | nil,
  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() | nil,
  ids: [binary()] | nil,
  limit: integer() | nil,
  after: Date.t() | binary() | nil,
  before: Date.t() | binary() | nil,
  types: [binary()] | nil,
  infraction_ids: [binary()] | nil,
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: {:ok, [t()], binary()} | {:error, [StarkInfra.Error.t()]}

Receive a list of up to 100 PixInfraction.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 infractions.

options

Options:

- `:cursor` [string, default nil]: cursor returned on the previous page function call
- `:ids` [list of strings, default nil]: Log ids to filter PixInfraction Logs. ex: ["5656565656565656"]
- `:limit` [integer, default 100]: maximum number of structs to be retrieved. Max = 100. ex: 35
- `:after` [Date or string, default nil]: date filter for structs created after a specified date. ex: ~D[2020-03-10]
- `:before` [Date or string, default nil]: date filter for structs created before a specified date. ex: ~D[2020-03-10]
- `:types` [list of strings, default nil]: filter retrieved structs by types. ex: ["created", "failed", "delivering", "delivered", "closed", "canceled"]
- `:infraction_ids` [list of strings, default nil]: list of PixInfraction ids to filter retrieved objects. 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 PixInfraction.Log structs with updated attributes
- cursor to retrieve the next page of PixInfraction.Log objects
@spec query!(
  ids: [binary()] | nil,
  limit: integer() | nil,
  after: Date.t() | binary() | nil,
  before: Date.t() | binary() | nil,
  types: [binary()] | nil,
  infraction_ids: [binary()] | nil,
  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()] | nil,
  limit: integer() | nil,
  after: Date.t() | binary() | nil,
  before: Date.t() | binary() | nil,
  types: [binary()] | nil,
  infraction_ids: [binary()] | nil,
  user: StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil
) :: {:ok, [t()]} | {:error, [StarkInfra.Error.t()]}

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

options

Options:

- `:ids` [list of strings, default nil]: Log ids to filter PixInfraction Logs. ex: ["5656565656565656"]
- `:limit` [integer, default 100]: maximum number of structs to be retrieved. Max = 100. ex: 35
- `:after` [Date or string, default nil]: date filter for structs created after specified date. ex: ~D[2020-03-10]
- `:before` [Date or string, default nil]: date filter for structs created before a specified date. ex: ~D[2020-03-10]
- `:types` [list of strings, default nil]: filter retrieved structs by types. ex: ["created", "failed", "delivering", "delivered", "closed", "canceled"]
- `:infraction_ids` [list of strings, default nil]: list of PixInfraction IDs to filter retrieved objects. 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 PixInfraction.Log structs with updated attributes