@linode/api-v4
Version:
JavaScript wrapper around the Linode APIv4
38 lines • 1.38 kB
TypeScript
import { Filter, Params, ResourcePage as Page } from '../types';
import { CreateTransferPayload, EntityTransfer } from '../entity-transfers/types';
/**
* getServiceTransfers
*
* Returns a paginated list of all Service Transfers which this customer has created or accepted.
*/
export declare const getServiceTransfers: (params?: Params, filter?: Filter) => Promise<Page<EntityTransfer>>;
/**
* getServiceTransfer
*
* Get a single Service Transfer by its token (uuid). A Pending transfer
* can be retrieved by any unrestricted user.
*
*/
export declare const getServiceTransfer: (token: string) => Promise<EntityTransfer>;
/**
* createServiceTransfer
*
* Creates a pending Service Transfer for one or more entities on
* the sender's account. Only unrestricted users can create a transfer.
*/
export declare const createServiceTransfer: (data: CreateTransferPayload) => Promise<EntityTransfer>;
/**
* acceptServiceTransfer
*
* Accepts a transfer that has been created by a user on a different account.
*/
export declare const acceptServiceTransfer: (token: string) => Promise<{}>;
/**
* cancelServiceTransfer
*
* Cancels a pending transfer. Only unrestricted users on the account
* that created the transfer are able to cancel it.
*
*/
export declare const cancelServiceTransfer: (token: string) => Promise<{}>;
//# sourceMappingURL=service-transfers.d.ts.map