RecipientTransfers interface
Interface que representa um RecipientTransfers.
Métodos
| accept(string, Accept |
Aceita uma solicitação de transferência. |
| decline(string, Recipient |
Recusa uma solicitação de transferência. |
| get(string, Recipient |
Obtém uma solicitação de transferência por ID. O chamador deve ser o destinatário da solicitação de transferência. |
| list(Recipient |
Lista as solicitações de transferência recebidas pelo chamador. |
| validate(string, Accept |
Valida se uma assinatura ou uma reserva pode ser transferida. Use esta operação para validar suas assinaturas ou reservas antes de usar a operação de transferência de aceitação. |
Detalhes do método
accept(string, AcceptTransferRequest, RecipientTransfersAcceptOptionalParams)
Aceita uma solicitação de transferência.
function accept(transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersAcceptOptionalParams): Promise<RecipientTransferDetails>Parâmetros
- transferName
-
string
A ID que identifica exclusivamente uma solicitação de transferência.
- parameters
- AcceptTransferRequest
Solicitar parâmetros fornecidos para a operação de transferência de aceitação.
Os parâmetros de opções.
Retornos
Promise<RecipientTransferDetails>
decline(string, RecipientTransfersDeclineOptionalParams)
Recusa uma solicitação de transferência.
function decline(transferName: string, options?: RecipientTransfersDeclineOptionalParams): Promise<RecipientTransferDetails>Parâmetros
- transferName
-
string
A ID que identifica exclusivamente uma solicitação de transferência.
Os parâmetros de opções.
Retornos
Promise<RecipientTransferDetails>
get(string, RecipientTransfersGetOptionalParams)
Obtém uma solicitação de transferência por ID. O chamador deve ser o destinatário da solicitação de transferência.
function get(transferName: string, options?: RecipientTransfersGetOptionalParams): Promise<RecipientTransferDetails>Parâmetros
- transferName
-
string
A ID que identifica exclusivamente uma solicitação de transferência.
Os parâmetros de opções.
Retornos
Promise<RecipientTransferDetails>
list(RecipientTransfersListOptionalParams)
Lista as solicitações de transferência recebidas pelo chamador.
function list(options?: RecipientTransfersListOptionalParams): PagedAsyncIterableIterator<RecipientTransferDetails, RecipientTransferDetails[], PageSettings>Parâmetros
Os parâmetros de opções.
Retornos
validate(string, AcceptTransferRequest, RecipientTransfersValidateOptionalParams)
Valida se uma assinatura ou uma reserva pode ser transferida. Use esta operação para validar suas assinaturas ou reservas antes de usar a operação de transferência de aceitação.
function validate(transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersValidateOptionalParams): Promise<ValidateTransferListResponse>Parâmetros
- transferName
-
string
A ID que identifica exclusivamente uma solicitação de transferência.
- parameters
- AcceptTransferRequest
Solicitar parâmetros fornecidos para a operação de transferência de validação.
Os parâmetros de opções.
Retornos
Promise<ValidateTransferListResponse>