RecipientTransfersOperations interface
Interface representing a RecipientTransfers operations.
Properties
| accept | Accepts a transfer request. |
| decline | Declines a transfer request. |
| get | Gets a transfer request by ID. The caller must be the recipient of the transfer request. |
| list | Lists the transfer requests received by the caller. |
| validate | 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. |
Property Details
accept
Accepts a transfer request.
accept: (transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersAcceptOptionalParams) => Promise<RecipientTransferDetails>
Property Value
(transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersAcceptOptionalParams) => Promise<RecipientTransferDetails>
decline
Declines a transfer request.
decline: (transferName: string, options?: RecipientTransfersDeclineOptionalParams) => Promise<RecipientTransferDetails>
Property Value
(transferName: string, options?: RecipientTransfersDeclineOptionalParams) => Promise<RecipientTransferDetails>
get
Gets a transfer request by ID. The caller must be the recipient of the transfer request.
get: (transferName: string, options?: RecipientTransfersGetOptionalParams) => Promise<RecipientTransferDetails>
Property Value
(transferName: string, options?: RecipientTransfersGetOptionalParams) => Promise<RecipientTransferDetails>
list
Lists the transfer requests received by the caller.
list: (options?: RecipientTransfersListOptionalParams) => PagedAsyncIterableIterator<RecipientTransferDetails, RecipientTransferDetails[], PageSettings>
Property Value
(options?: RecipientTransfersListOptionalParams) => PagedAsyncIterableIterator<RecipientTransferDetails, RecipientTransferDetails[], PageSettings>
validate
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.
validate: (transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersValidateOptionalParams) => Promise<ValidateTransferListResponse>
Property Value
(transferName: string, parameters: AcceptTransferRequest, options?: RecipientTransfersValidateOptionalParams) => Promise<ValidateTransferListResponse>