RecipientTransfers interface
Interface representing a RecipientTransfers.
Methods
| accept(string, Accept |
Accepts a transfer request. |
| decline(string, Recipient |
Declines a transfer request. |
| get(string, Recipient |
Gets a transfer request by ID. The caller must be the recipient of the transfer request. |
| list(Recipient |
Lists the transfer requests received by the caller. |
| validate(string, Accept |
Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation. |
Method Details
accept(string, AcceptTransferRequest, RecipientTransfersAcceptOptionalParams)
Accepts a transfer request.
function accept(transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersAcceptOptionalParams): Promise<RecipientTransferDetails>Parameters
- transferName
-
string
The ID that uniquely identifies a transfer request.
- parameters
- AcceptTransferRequest
Request parameters that are provided to the accept transfer operation.
The options parameters.
Returns
Promise<RecipientTransferDetails>
decline(string, RecipientTransfersDeclineOptionalParams)
Declines a transfer request.
function decline(transferName: string, options?: RecipientTransfersDeclineOptionalParams): Promise<RecipientTransferDetails>Parameters
- transferName
-
string
The ID that uniquely identifies a transfer request.
The options parameters.
Returns
Promise<RecipientTransferDetails>
get(string, RecipientTransfersGetOptionalParams)
Gets a transfer request by ID. The caller must be the recipient of the transfer request.
function get(transferName: string, options?: RecipientTransfersGetOptionalParams): Promise<RecipientTransferDetails>Parameters
- transferName
-
string
The ID that uniquely identifies a transfer request.
The options parameters.
Returns
Promise<RecipientTransferDetails>
list(RecipientTransfersListOptionalParams)
Lists the transfer requests received by the caller.
function list(options?: RecipientTransfersListOptionalParams): PagedAsyncIterableIterator<RecipientTransferDetails, RecipientTransferDetails[], PageSettings>Parameters
The options parameters.
Returns
validate(string, AcceptTransferRequest, RecipientTransfersValidateOptionalParams)
Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.
function validate(transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersValidateOptionalParams): Promise<ValidateTransferListResponse>Parameters
- transferName
-
string
The ID that uniquely identifies a transfer request.
- parameters
- AcceptTransferRequest
Request parameters that are provided to the validate transfer operation.
The options parameters.
Returns
Promise<ValidateTransferListResponse>