View Source StarkInfra.PixDomain (starkinfra v0.0.1)

Groups PixDomain related functions

Link to this section Summary

Functions

The PixDomain struct displays the QR Code domain certificate information of Pix participants. All certificates must be registered with the Central Bank.

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

Receive a stream of PixDomain objects.

Link to this section Types

@type t() :: %StarkInfra.PixDomain{certificates: term(), name: term()}

Link to this section Functions

Link to this function

%StarkInfra.PixDomain{}

View Source (struct)

The PixDomain struct displays the QR Code domain certificate information of Pix participants. All certificates must be registered with the Central Bank.

attributes-return-only

Attributes (return-only):

- certificates [list of PixDomain.Certificate]: certificate information of the Pix participant.
- name [string]: current active domain (URL) of the Pix participant.
@spec query!([
  {:user, StarkInfra.User.Organization.t() | StarkInfra.User.Project.t() | nil}
]) :: any()

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

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

Receive a stream of PixDomain objects.

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:

- stream of PixDomain structs with updated attributes