Class Convites

Hierarchy (View Summary)

Requester
- Convites

Index

Constructors

Properties

__PARENT_NAME__ requester

Methods

create unwrap aceitar

Constructors

constructor

new Convites(parent: SuperUser): Convites
O construtor é usado para ações autenticadas que vêm de um 'parent' (SuperUser).
Parameters
- parent: SuperUser
Returns Convites
Overrides Requester.constructor
- Defined in convite.ts:12

Properties

__PARENT_NAME__

__PARENT_NAME__: string

requester

requester: AxiosInstance

Methods

create

create(email: string): Promise<ApiResponse<CorretorResponse>>
Cria um novo convite para um corretor e dispara o e-mail.
Parameters
- email: string
  O e-mail do corretor a ser convidado.
Returns Promise<ApiResponse<CorretorResponse>>
- Defined in convite.ts:22

`Protected`unwrap

unwrap<T>(p: Promise<AxiosResponse<T, any, {}>>): Promise<ApiResponse<T>>
Type Parameters
- T
Parameters
- p: Promise<AxiosResponse<T, any, {}>>
Returns Promise<ApiResponse<T>>
Inherited from Requester.unwrap
- Defined in requester.ts:20

`Static`aceitar

aceitar(
    conviteId: string,
    payload: AceitarConvite,
    environment: "prod" | "dev",
): Promise<AceitarConviteResponse>
Finaliza o cadastro de um novo utilizador a partir de um convite.
Parameters
- conviteId: string
  O ID do convite.
- payload: AceitarConvite
  Os dados do novo utilizador (nome, senha, telefone).
- environment: "prod" | "dev"
  O ambiente ('dev' ou 'prod') para saber qual API chamar.
Returns Promise<AceitarConviteResponse>
- Defined in convite.ts:35