import { CacheAction, ICacheOptions, OvhRequestable } from '@ovh-api/common'; /** * START API /allDom Models * Source: https://eu.api.soyoustart.com/1.0/allDom.json */ export declare namespace allDom { /** * AllDom administration * interface fullName: allDom.AllDom.AllDom */ interface AllDom { name: string; offer: domain.OfferEnum; type: allDom.TypeEnum; } /** * Domain name of a allDom * interface fullName: allDom.AllDomDomain.AllDomDomain */ interface AllDomDomain { domain: string; } /** * Type * type fullname: allDom.TypeEnum */ type TypeEnum = "french" | "french+international" | "international"; } export declare namespace domain { /** * Offer * type fullname: domain.OfferEnum */ type OfferEnum = "diamond" | "gold" | "platinum"; } export declare namespace service { /** * Map a possible renew for a specific service * interface fullName: service.RenewType.RenewType */ interface RenewType { automatic: boolean; deleteAtExpiration: boolean; forced: boolean; manualPayment?: boolean; period?: number; } /** * Detailed renewal type of a service * type fullname: service.RenewalTypeEnum */ type RenewalTypeEnum = "automaticForcedProduct" | "automaticV2012" | "automaticV2014" | "automaticV2016" | "manual" | "oneShot" | "option"; /** * type fullname: service.StateEnum */ type StateEnum = "expired" | "inCreation" | "ok" | "pendingDebt" | "unPaid"; } export declare namespace services { /** * Details about a Service * interface fullName: services.Service.Service */ interface Service { canDeleteAtExpiration: boolean; contactAdmin: string; contactBilling: string; contactTech: string; creation: string; domain: string; engagedUpTo?: string; expiration: string; possibleRenewPeriod?: number[]; renew?: service.RenewType; renewalType: service.RenewalTypeEnum; serviceId: number; status: service.StateEnum; } } /** * END API /allDom Models */ export declare function proxyAllDom(ovhEngine: OvhRequestable): AllDom; export default proxyAllDom; /** * Api model for /allDom */ export interface AllDom { /** * List available services * GET /allDom */ $get(): Promise; /** * Controle cache */ $cache(param?: ICacheOptions | CacheAction): Promise; $(serviceName: string): { /** * Get this object properties * GET /allDom/{serviceName} */ $get(): Promise; /** * Controle cache */ $cache(param?: ICacheOptions | CacheAction): Promise; domain: { /** * Domains attached to this allDom * GET /allDom/{serviceName}/domain */ $get(params?: { domain?: string; }): Promise; /** * Controle cache */ $cache(param?: ICacheOptions | CacheAction): Promise; $(domain: string): { /** * Get this object properties * GET /allDom/{serviceName}/domain/{domain} */ $get(): Promise; /** * Controle cache */ $cache(param?: ICacheOptions | CacheAction): Promise; }; }; serviceInfos: { /** * Get this object properties * GET /allDom/{serviceName}/serviceInfos */ $get(): Promise; /** * Alter this object properties * PUT /allDom/{serviceName}/serviceInfos */ $put(params?: { canDeleteAtExpiration?: boolean; contactAdmin?: string; contactBilling?: string; contactTech?: string; creation?: string; domain?: string; engagedUpTo?: string; expiration?: string; possibleRenewPeriod?: number[]; renew?: service.RenewType; renewalType?: service.RenewalTypeEnum; serviceId?: number; status?: service.StateEnum; }): Promise; /** * Controle cache */ $cache(param?: ICacheOptions | CacheAction): Promise; }; }; }