@marxlnfcs/wildduck-api
Version:
Provides a client to interact with the wildduck api
19 lines (18 loc) • 2.53 kB
TypeScript
import { WildduckClientComponent } from "../../client-component";
import { IWildduckApiCreateForwardedAddressRequest, IWildduckApiCreateForwardedAddressResponse, IWildduckApiCreateUserAddressRequest, IWildduckApiCreateUserAddressResponse, IWildduckApiGetAddressesResponse, IWildduckApiGetForwardedAddressResponse, IWildduckApiGetUserAddressesregisterResponse, IWildduckApiGetUserAddressesResponse, IWildduckApiGetUserAddressResponse, IWildduckApiRenameDomainRequest, IWildduckApiResolveAddressResponse, IWildduckApiSuccessResponse, IWildduckApiUpdateForwardedAddressRequest, IWildduckApiUpdateUserAddressRequest } from "../../client-schema";
import { IWildduckApiGetAddressesOptions, IWildduckApiGetUserAddressesOptions, IWildduckApiGetUserAddressesregisterOptions, IWildduckApiResolveAddressOptions } from "./addresses.interface";
export declare class WildduckAddressesService extends WildduckClientComponent {
deleteForwardedAddress(address: string): Promise<IWildduckApiSuccessResponse>;
getForwardedAddress(address: string): Promise<IWildduckApiGetForwardedAddressResponse>;
updateForwardedAddress(address: string, dto: IWildduckApiUpdateForwardedAddressRequest): Promise<IWildduckApiSuccessResponse>;
deleteUserAddress(user: string, address: string): Promise<IWildduckApiSuccessResponse>;
getUserAddress(user: string, address: string): Promise<IWildduckApiGetUserAddressResponse>;
updateUserAddress(user: string, address: string, dto: IWildduckApiUpdateUserAddressRequest): Promise<IWildduckApiSuccessResponse>;
resolveAddress(address: string, options?: Partial<IWildduckApiResolveAddressOptions>): Promise<IWildduckApiResolveAddressResponse>;
getRegisteredAddresses(options?: Partial<IWildduckApiGetAddressesOptions>): Promise<IWildduckApiGetAddressesResponse>;
getRegisteredUserAddresses(user: string, options?: Partial<IWildduckApiGetUserAddressesOptions>): Promise<IWildduckApiGetUserAddressesResponse>;
createUserAddress(user: string, dto: IWildduckApiCreateUserAddressRequest): Promise<IWildduckApiCreateUserAddressResponse>;
getUserAddressesFromRegister(user: string, options?: Partial<IWildduckApiGetUserAddressesregisterOptions> & Pick<IWildduckApiGetUserAddressesregisterOptions, 'query'>): Promise<IWildduckApiGetUserAddressesregisterResponse>;
createForwardedAddress(dto: IWildduckApiCreateForwardedAddressRequest): Promise<IWildduckApiCreateForwardedAddressResponse>;
renameDomain(dto: IWildduckApiRenameDomainRequest): Promise<IWildduckApiSuccessResponse>;
}