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