View Source StarkInfra.PixDirector (starkinfra v0.1.0)

Groups PixDirector related functions

Link to this section Summary

Functions

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

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

Send a PixDirector struct for creation in the Stark Infra API

Link to this section Types

@type t() :: %StarkInfra.PixDirector{
  email: term(),
  id: term(),
  name: term(),
  password: term(),
  phone: term(),
  status: term(),
  tax_id: term(),
  team_email: term(),
  team_phones: term()
}

Link to this section Functions

Link to this function

%StarkInfra.PixDirector{}

View Source (struct)

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

Parameters (required):

  • :name [string]: name of the PixDirector. ex: "Edward Stark".
  • :tax_id [string]: tax ID (CPF/CNPJ) of the PixDirector. ex: "03.300.300/0001-00"
  • :phone [string]: phone of the PixDirector. ex: "+551198989898"
  • :email [string]: email of the PixDirector. ex: "ned.stark@starkbank.com"
  • :password [string]: password of the PixDirector. ex: "12345678"
  • :team_email [string]: team email. ex: "aria.stark@starkbank.com"
  • :team_phones [list of strings]: list of phones of the team. ex: ["+5511988889999", "+5511988889998"]

attributes-return-only

Attributes (return-only):

  • :id [string]: unique id returned when the PixDirector is created. ex: "5656565656565656"
  • :status [string]: current PixDirector status. ex: "success"
Link to this function

create!(director, options \\ [])

View Source
@spec create!(t() | map(), [
  {:user, StarkInfra.User.Project.t() | StarkInfra.User.Organization.t() | nil}
]) :: any()

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

Link to this function

create(director, options \\ [])

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

Send a PixDirector struct for creation in the Stark Infra API

parameters-required

Parameters (required):

  • :director [PixDirector struct]: PixDirector struct to be created in the API

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:

  • PixDirector struct with updated attributes