@ovh-api/ssl-gateway - npm Package Compare versions

Comparing version 2.0.13 to 3.0.0

index.d.ts

@@ -1,2 +0,2 @@
-import { OvhRequestable } from '@ovh-api/common';
+import { ICacheOptions, OvhRequestable } from '@ovh-api/common';
 /**
@@ -7,2 +7,6 @@ * START API /sslGateway Models
 export declare namespace service {
+    /**
+     * Map a possible renew for a specific service
+     * interface fullName: service.RenewType.RenewType
+     */
     interface RenewType {
@@ -15,8 +19,27 @@ automatic: boolean;
     }
+    /**
+     * 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";
+    /**
+     * All future uses you can provide for a service termination
+     * type fullname: service.TerminationFutureUseEnum
+     */
     type TerminationFutureUseEnum = "NOT_REPLACING_SERVICE" | "OTHER" | "SUBSCRIBE_AN_OTHER_SERVICE" | "SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR" | "SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR";
+    /**
+     * All reasons you can provide for a service termination
+     * type fullname: service.TerminationReasonEnum
+     */
     type TerminationReasonEnum = "FEATURES_DONT_SUIT_ME" | "LACK_OF_PERFORMANCES" | "MIGRATED_TO_ANOTHER_OVH_PRODUCT" | "MIGRATED_TO_COMPETITOR" | "NOT_ENOUGH_RECOGNITION" | "NOT_NEEDED_ANYMORE" | "NOT_RELIABLE" | "NO_ANSWER" | "OTHER" | "PRODUCT_DIMENSION_DONT_SUIT_ME" | "PRODUCT_TOOLS_DONT_SUIT_ME" | "TOO_EXPENSIVE" | "TOO_HARD_TO_USE" | "UNSATIFIED_BY_CUSTOMER_SUPPORT";
 }
 export declare namespace services {
+    /**
+     * Details about a Service
+     * interface fullName: services.Service.Service
+     */
     interface Service {
@@ -39,2 +62,6 @@ canDeleteAtExpiration: boolean;
 export declare namespace sslGateway {
+    /**
+     * Domain attached to an SSL Gateway
+     * interface fullName: sslGateway.Domain.Domain
+     */
     interface Domain {
@@ -45,3 +72,11 @@ domain: string;
     }
+    /**
+     * Possible values for SSL Gateway domain state
+     * type fullname: sslGateway.DomainStateEnum
+     */
     type DomainStateEnum = "creating" | "deleted" | "deleting" | "http-only" | "internal" | "ok";
+    /**
+     * A structure describing the eligibility status of a domain
+     * interface fullName: sslGateway.EligibilityStatus.EligibilityStatus
+     */
     interface EligibilityStatus {
@@ -53,2 +88,6 @@ domain: string;
     }
+    /**
+     * a list of {zone, nat Ip}
+     * interface fullName: sslGateway.NatIps.NatIps
+     */
     interface NatIps {
@@ -58,3 +97,11 @@ ip: string[];
     }
+    /**
+     * List of SSL Gateway offers
+     * type fullname: sslGateway.OfferEnum
+     */
     type OfferEnum = "advanced" | "enterprise" | "free" | "internal";
+    /**
+     * Server attached to an SSL Gateway
+     * interface fullName: sslGateway.Server.Server
+     */
     interface Server {
@@ -66,4 +113,16 @@ address: string;
     }
+    /**
+     * Possible values for SSL Gateway server state
+     * type fullname: sslGateway.ServerStateEnum
+     */
     type ServerStateEnum = "creating" | "deleted" | "deleting" | "internal" | "ok" | "updating";
+    /**
+     * Possible values for ssl ciphers
+     * type fullname: sslGateway.SslConfigurationEnum
+     */
     type SslConfigurationEnum = "intermediate" | "internal" | "modern";
+    /**
+     * Your SSL Gateway
+     * interface fullName: sslGateway.SslGateway.SslGateway
+     */
     interface SslGateway {
@@ -85,3 +144,11 @@ allowedSource?: string[];
     }
+    /**
+     * Possible values for SSL Gateway state
+     * type fullname: sslGateway.StateEnum
+     */
     type StateEnum = "creating" | "deleted" | "deleting" | "http-only" | "internal" | "ok" | "suspended" | "upgrading";
+    /**
+     * SSL Gateway tasks
+     * interface fullName: sslGateway.Task.Task
+     */
     interface Task {
@@ -94,3 +161,11 @@ action: sslGateway.TaskActionEnum;
     }
+    /**
+     * Possible task action
+     * type fullname: sslGateway.TaskActionEnum
+     */
     type TaskActionEnum = "addDomain" | "addPaidCertificate" | "addServer" | "createService" | "deleteDomain" | "deleteServer" | "deleteService" | "internalTask" | "updateServer" | "updateService" | "upgrade";
+    /**
+     * Possible task status
+     * type fullname: sslGateway.TaskStatusEnum
+     */
     type TaskStatusEnum = "blocked" | "cancelled" | "doing" | "done" | "error" | "paused" | "todo";
@@ -104,15 +179,48 @@ }
 /**
- * Api Proxy model
- */ export interface SslGateway {
+ * Api model for /sslGateway
+ */
+export interface SslGateway {
+    /**
+     * List available services
+     * GET /sslGateway
+     */
     $get(): Promise<string[]>;
+    /**
+     * Controle cache
+     */
+    $cache(param?: ICacheOptions): Promise<any>;
     availableZones: {
+        /**
+         * List of zone available for an SSL Gateway
+         * GET /sslGateway/availableZones
+         */
         $get(): Promise<string[]>;
+        /**
+         * Controle cache
+         */
+        $cache(param?: ICacheOptions): Promise<any>;
     };
     eligibility: {
+        /**
+         * Check domain eligibility. Return list of eligible IP(s) for this domain.
+         * GET /sslGateway/eligibility
+         */
         $get(params: {
             domain: string;
         }): Promise<sslGateway.EligibilityStatus>;
+        /**
+         * Controle cache
+         */
+        $cache(param?: ICacheOptions): Promise<any>;
     };
     $(serviceName: string): {
+        /**
+         * Get this object properties
+         * GET /sslGateway/{serviceName}
+         */
         $get(): Promise<sslGateway.SslGateway>;
+        /**
+         * Alter this object properties
+         * PUT /sslGateway/{serviceName}
+         */
         $put(params?: {
@@ -134,3 +242,11 @@ allowedSource?: string[];
         }): Promise<void>;
+        /**
+         * Controle cache
+         */
+        $cache(param?: ICacheOptions): Promise<any>;
         changeContact: {
+            /**
+             * Launch a contact change procedure
+             * POST /sslGateway/{serviceName}/changeContact
+             */
             $post(params?: {
@@ -141,4 +257,12 @@ contactAdmin?: string;
             }): Promise<number[]>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         };
         confirmTermination: {
+            /**
+             * Confirm termination of your service
+             * POST /sslGateway/{serviceName}/confirmTermination
+             */
             $post(params: {
@@ -150,23 +274,75 @@ commentary?: string;
             }): Promise<string>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         };
         domain: {
+            /**
+             * Domains attached to your SSL Gateway
+             * GET /sslGateway/{serviceName}/domain
+             */
             $get(): Promise<number[]>;
+            /**
+             * Attach a new domain to your SSL Gateway
+             * POST /sslGateway/{serviceName}/domain
+             */
             $post(params: {
                 domain: string;
             }): Promise<sslGateway.Domain>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
             $(id: number): {
+                /**
+                 * Detach a domain from your SSL Gateway
+                 * DELETE /sslGateway/{serviceName}/domain/{id}
+                 */
                 $delete(): Promise<void>;
+                /**
+                 * Get this object properties
+                 * GET /sslGateway/{serviceName}/domain/{id}
+                 */
                 $get(): Promise<sslGateway.Domain>;
+                /**
+                 * Controle cache
+                 */
+                $cache(param?: ICacheOptions): Promise<any>;
             };
         };
         natIp: {
+            /**
+             * Ip subnet used by OVH to nat requests to your SSL Gateway backends.
+             * GET /sslGateway/{serviceName}/natIp
+             */
             $get(): Promise<sslGateway.NatIps[]>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         };
         renewCertificate: {
+            /**
+             * Renew your SSL certificates
+             * POST /sslGateway/{serviceName}/renewCertificate
+             */
             $post(params?: {
                 domain?: string;
             }): Promise<string[]>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         };
         server: {
+            /**
+             * Servers attached to your SSL Gateway
+             * GET /sslGateway/{serviceName}/server
+             */
             $get(): Promise<number[]>;
+            /**
+             * Add a new server to your SSL Gateway
+             * POST /sslGateway/{serviceName}/server
+             */
             $post(params: {
@@ -176,5 +352,21 @@ address: string;
             }): Promise<sslGateway.Server>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
             $(id: number): {
+                /**
+                 * Remove a server
+                 * DELETE /sslGateway/{serviceName}/server/{id}
+                 */
                 $delete(): Promise<void>;
+                /**
+                 * Get this object properties
+                 * GET /sslGateway/{serviceName}/server/{id}
+                 */
                 $get(): Promise<sslGateway.Server>;
+                /**
+                 * Alter this object properties
+                 * PUT /sslGateway/{serviceName}/server/{id}
+                 */
                 $put(params?: {
@@ -186,6 +378,18 @@ address?: string;
                 }): Promise<void>;
+                /**
+                 * Controle cache
+                 */
+                $cache(param?: ICacheOptions): Promise<any>;
             };
         };
         serviceInfos: {
+            /**
+             * Get this object properties
+             * GET /sslGateway/{serviceName}/serviceInfos
+             */
             $get(): Promise<services.Service>;
+            /**
+             * Alter this object properties
+             * PUT /sslGateway/{serviceName}/serviceInfos
+             */
             $put(params?: {
@@ -206,216 +410,41 @@ canDeleteAtExpiration?: boolean;
             }): Promise<void>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         };
         task: {
+            /**
+             * Task for this SSL Gateway
+             * GET /sslGateway/{serviceName}/task
+             */
             $get(): Promise<number[]>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
             $(id: number): {
+                /**
+                 * Get this object properties
+                 * GET /sslGateway/{serviceName}/task/{id}
+                 */
                 $get(): Promise<sslGateway.Task>;
+                /**
+                 * Controle cache
+                 */
+                $cache(param?: ICacheOptions): Promise<any>;
             };
         };
         terminate: {
+            /**
+             * Terminate your service
+             * POST /sslGateway/{serviceName}/terminate
+             */
             $post(): Promise<string>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         };
     };
-    /**
-     * Operations about the SSLGATEWAY service
-     * List available services
-     */
-    get(path: '/sslGateway'): () => Promise<string[]>;
-    /**
-     * Your SSL Gateway
-     * Get this object properties
-     */
-    get(path: '/sslGateway/{serviceName}'): (params: {
-        serviceName: string;
-    }) => Promise<sslGateway.SslGateway>;
-    /**
-     * List the sslGateway.Domain objects
-     * Domains attached to your SSL Gateway
-     */
-    get(path: '/sslGateway/{serviceName}/domain'): (params: {
-        serviceName: string;
-    }) => Promise<number[]>;
-    /**
-     * Domain attached to an SSL Gateway
-     * Get this object properties
-     */
-    get(path: '/sslGateway/{serviceName}/domain/{id}'): (params: {
-        id: number;
-        serviceName: string;
-    }) => Promise<sslGateway.Domain>;
-    /**
-     * natIp operations
-     * Ip subnet used by OVH to nat requests to your SSL Gateway backends.
-     */
-    get(path: '/sslGateway/{serviceName}/natIp'): (params: {
-        serviceName: string;
-    }) => Promise<sslGateway.NatIps[]>;
-    /**
-     * List the sslGateway.Server objects
-     * Servers attached to your SSL Gateway
-     */
-    get(path: '/sslGateway/{serviceName}/server'): (params: {
-        serviceName: string;
-    }) => Promise<number[]>;
-    /**
-     * Server attached to an SSL Gateway
-     * Get this object properties
-     */
-    get(path: '/sslGateway/{serviceName}/server/{id}'): (params: {
-        id: number;
-        serviceName: string;
-    }) => Promise<sslGateway.Server>;
-    /**
-     * Details about a Service
-     * Get this object properties
-     */
-    get(path: '/sslGateway/{serviceName}/serviceInfos'): (params: {
-        serviceName: string;
-    }) => Promise<services.Service>;
-    /**
-     * List the sslGateway.Task objects
-     * Task for this SSL Gateway
-     */
-    get(path: '/sslGateway/{serviceName}/task'): (params: {
-        serviceName: string;
-    }) => Promise<number[]>;
-    /**
-     * SSL Gateway tasks
-     * Get this object properties
-     */
-    get(path: '/sslGateway/{serviceName}/task/{id}'): (params: {
-        id: number;
-        serviceName: string;
-    }) => Promise<sslGateway.Task>;
-    /**
-     * List of zone available for an SSL Gateway
-     * List of zone available for an SSL Gateway
-     */
-    get(path: '/sslGateway/availableZones'): () => Promise<string[]>;
-    /**
-     * Check domain eligibility. Return list of eligible IP(s) for this domain.
-     * Check domain eligibility. Return list of eligible IP(s) for this domain.
-     */
-    get(path: '/sslGateway/eligibility'): (params: {
-        domain: string;
-    }) => Promise<sslGateway.EligibilityStatus>;
-    /**
-     * Your SSL Gateway
-     * Alter this object properties
-     */
-    put(path: '/sslGateway/{serviceName}'): (params: {
-        serviceName: string;
-        allowedSource?: string[];
-        displayName?: string;
-        hsts?: boolean;
-        httpsRedirect?: boolean;
-        ipv4?: string;
-        ipv6?: string;
-        metricsToken?: string;
-        offer?: sslGateway.OfferEnum;
-        reverse?: string;
-        serverHttps?: boolean;
-        sslConfiguration?: sslGateway.SslConfigurationEnum;
-        state?: sslGateway.StateEnum;
-        zones?: string[];
-    }) => Promise<void>;
-    /**
-     * Server attached to an SSL Gateway
-     * Alter this object properties
-     */
-    put(path: '/sslGateway/{serviceName}/server/{id}'): (params: {
-        id: number;
-        serviceName: string;
-        address?: string;
-        port?: number;
-        state?: sslGateway.ServerStateEnum;
-    }) => Promise<void>;
-    /**
-     * Details about a Service
-     * Alter this object properties
-     */
-    put(path: '/sslGateway/{serviceName}/serviceInfos'): (params: {
-        serviceName: string;
-        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<void>;
-    /**
-     * Change the contacts of this service
-     * Launch a contact change procedure
-     */
-    post(path: '/sslGateway/{serviceName}/changeContact'): (params: {
-        serviceName: string;
-        contactAdmin?: string;
-        contactBilling?: string;
-        contactTech?: string;
-    }) => Promise<number[]>;
-    /**
-     * Confirm termination of your service
-     * Confirm termination of your service
-     */
-    post(path: '/sslGateway/{serviceName}/confirmTermination'): (params: {
-        serviceName: string;
-        commentary?: string;
-        futureUse?: service.TerminationFutureUseEnum;
-        reason?: service.TerminationReasonEnum;
-        token: string;
-    }) => Promise<string>;
-    /**
-     * List the sslGateway.Domain objects
-     * Attach a new domain to your SSL Gateway
-     */
-    post(path: '/sslGateway/{serviceName}/domain'): (params: {
-        serviceName: string;
-        domain: string;
-    }) => Promise<sslGateway.Domain>;
-    /**
-     * renewCertificate operations
-     * Renew your SSL certificates
-     */
-    post(path: '/sslGateway/{serviceName}/renewCertificate'): (params: {
-        serviceName: string;
-        domain?: string;
-    }) => Promise<string[]>;
-    /**
-     * List the sslGateway.Server objects
-     * Add a new server to your SSL Gateway
-     */
-    post(path: '/sslGateway/{serviceName}/server'): (params: {
-        serviceName: string;
-        address: string;
-        port: number;
-    }) => Promise<sslGateway.Server>;
-    /**
-     * Terminate your service
-     * Terminate your service
-     */
-    post(path: '/sslGateway/{serviceName}/terminate'): (params: {
-        serviceName: string;
-    }) => Promise<string>;
-    /**
-     * Domain attached to an SSL Gateway
-     * Detach a domain from your SSL Gateway
-     */
-    delete(path: '/sslGateway/{serviceName}/domain/{id}'): (params: {
-        id: number;
-        serviceName: string;
-    }) => Promise<void>;
-    /**
-     * Server attached to an SSL Gateway
-     * Remove a server
-     */
-    delete(path: '/sslGateway/{serviceName}/server/{id}'): (params: {
-        id: number;
-        serviceName: string;
-    }) => Promise<void>;
 }

index.ts

@@ -1,2 +0,2 @@
-import { OvhRequestable, buildOvhProxy } from '@ovh-api/common';
+import { buildOvhProxy, ICacheOptions, OvhRequestable } from '@ovh-api/common';
 
@@ -8,3 +8,6 @@ /**
 export namespace service {
-    // interface fullName: service.RenewType.RenewType
+    /**
+     * Map a possible renew for a specific service
+     * interface fullName: service.RenewType.RenewType
+     */
     export interface RenewType {
@@ -17,13 +20,27 @@ automatic: boolean;
     }
-    // type fullname: service.RenewalTypeEnum
+    /**
+     * Detailed renewal type of a service
+     * type fullname: service.RenewalTypeEnum
+     */
     export type RenewalTypeEnum = "automaticForcedProduct" | "automaticV2012" | "automaticV2014" | "automaticV2016" | "manual" | "oneShot" | "option"
-    // type fullname: service.StateEnum
+    /**
+     * type fullname: service.StateEnum
+     */
     export type StateEnum = "expired" | "inCreation" | "ok" | "pendingDebt" | "unPaid"
-    // type fullname: service.TerminationFutureUseEnum
+    /**
+     * All future uses you can provide for a service termination
+     * type fullname: service.TerminationFutureUseEnum
+     */
     export type TerminationFutureUseEnum = "NOT_REPLACING_SERVICE" | "OTHER" | "SUBSCRIBE_AN_OTHER_SERVICE" | "SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR" | "SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR"
-    // type fullname: service.TerminationReasonEnum
+    /**
+     * All reasons you can provide for a service termination
+     * type fullname: service.TerminationReasonEnum
+     */
     export type TerminationReasonEnum = "FEATURES_DONT_SUIT_ME" | "LACK_OF_PERFORMANCES" | "MIGRATED_TO_ANOTHER_OVH_PRODUCT" | "MIGRATED_TO_COMPETITOR" | "NOT_ENOUGH_RECOGNITION" | "NOT_NEEDED_ANYMORE" | "NOT_RELIABLE" | "NO_ANSWER" | "OTHER" | "PRODUCT_DIMENSION_DONT_SUIT_ME" | "PRODUCT_TOOLS_DONT_SUIT_ME" | "TOO_EXPENSIVE" | "TOO_HARD_TO_USE" | "UNSATIFIED_BY_CUSTOMER_SUPPORT"
 }
 export namespace services {
-    // interface fullName: services.Service.Service
+    /**
+     * Details about a Service
+     * interface fullName: services.Service.Service
+     */
     export interface Service {
@@ -46,3 +63,6 @@ canDeleteAtExpiration: boolean;
 export namespace sslGateway {
-    // interface fullName: sslGateway.Domain.Domain
+    /**
+     * Domain attached to an SSL Gateway
+     * interface fullName: sslGateway.Domain.Domain
+     */
     export interface Domain {
@@ -53,5 +73,11 @@ domain: string;
     }
-    // type fullname: sslGateway.DomainStateEnum
+    /**
+     * Possible values for SSL Gateway domain state
+     * type fullname: sslGateway.DomainStateEnum
+     */
     export type DomainStateEnum = "creating" | "deleted" | "deleting" | "http-only" | "internal" | "ok"
-    // interface fullName: sslGateway.EligibilityStatus.EligibilityStatus
+    /**
+     * A structure describing the eligibility status of a domain
+     * interface fullName: sslGateway.EligibilityStatus.EligibilityStatus
+     */
     export interface EligibilityStatus {
@@ -63,3 +89,6 @@ domain: string;
     }
-    // interface fullName: sslGateway.NatIps.NatIps
+    /**
+     * a list of {zone, nat Ip}
+     * interface fullName: sslGateway.NatIps.NatIps
+     */
     export interface NatIps {
@@ -69,5 +98,11 @@ ip: string[];
     }
-    // type fullname: sslGateway.OfferEnum
+    /**
+     * List of SSL Gateway offers
+     * type fullname: sslGateway.OfferEnum
+     */
     export type OfferEnum = "advanced" | "enterprise" | "free" | "internal"
-    // interface fullName: sslGateway.Server.Server
+    /**
+     * Server attached to an SSL Gateway
+     * interface fullName: sslGateway.Server.Server
+     */
     export interface Server {
@@ -79,7 +114,16 @@ address: string;
     }
-    // type fullname: sslGateway.ServerStateEnum
+    /**
+     * Possible values for SSL Gateway server state
+     * type fullname: sslGateway.ServerStateEnum
+     */
     export type ServerStateEnum = "creating" | "deleted" | "deleting" | "internal" | "ok" | "updating"
-    // type fullname: sslGateway.SslConfigurationEnum
+    /**
+     * Possible values for ssl ciphers
+     * type fullname: sslGateway.SslConfigurationEnum
+     */
     export type SslConfigurationEnum = "intermediate" | "internal" | "modern"
-    // interface fullName: sslGateway.SslGateway.SslGateway
+    /**
+     * Your SSL Gateway
+     * interface fullName: sslGateway.SslGateway.SslGateway
+     */
     export interface SslGateway {
@@ -101,5 +145,11 @@ allowedSource?: string[];
     }
-    // type fullname: sslGateway.StateEnum
+    /**
+     * Possible values for SSL Gateway state
+     * type fullname: sslGateway.StateEnum
+     */
     export type StateEnum = "creating" | "deleted" | "deleting" | "http-only" | "internal" | "ok" | "suspended" | "upgrading"
-    // interface fullName: sslGateway.Task.Task
+    /**
+     * SSL Gateway tasks
+     * interface fullName: sslGateway.Task.Task
+     */
     export interface Task {
@@ -112,5 +162,11 @@ action: sslGateway.TaskActionEnum;
     }
-    // type fullname: sslGateway.TaskActionEnum
+    /**
+     * Possible task action
+     * type fullname: sslGateway.TaskActionEnum
+     */
     export type TaskActionEnum = "addDomain" | "addPaidCertificate" | "addServer" | "createService" | "deleteDomain" | "deleteServer" | "deleteService" | "internalTask" | "updateServer" | "updateService" | "upgrade"
-    // type fullname: sslGateway.TaskStatusEnum
+    /**
+     * Possible task status
+     * type fullname: sslGateway.TaskStatusEnum
+     */
     export type TaskStatusEnum = "blocked" | "cancelled" | "doing" | "done" | "error" | "paused" | "todo"
@@ -127,198 +183,214 @@ }
 /**
- * Api Proxy model
- */// Apis harmony
-// path /sslGateway
-export interface SslGateway{
-    // GET /sslGateway
+ * Api model for /sslGateway
+ */
+export interface SslGateway {
+    /**
+     * List available services
+     * GET /sslGateway
+     */
     $get(): Promise<string[]>;
+    /**
+     * Controle cache
+     */
+    $cache(param?: ICacheOptions): Promise<any>;
     availableZones: {
-        // GET /sslGateway/availableZones
+        /**
+         * List of zone available for an SSL Gateway
+         * GET /sslGateway/availableZones
+         */
         $get(): Promise<string[]>;
+        /**
+         * Controle cache
+         */
+        $cache(param?: ICacheOptions): Promise<any>;
     }
     eligibility: {
-        // GET /sslGateway/eligibility
-        $get(params: {domain: string}): Promise<sslGateway.EligibilityStatus>;
+        /**
+         * Check domain eligibility. Return list of eligible IP(s) for this domain.
+         * GET /sslGateway/eligibility
+         */
+        $get(params: { domain: string }): Promise<sslGateway.EligibilityStatus>;
+        /**
+         * Controle cache
+         */
+        $cache(param?: ICacheOptions): Promise<any>;
     }
     $(serviceName: string): {
-        // GET /sslGateway/{serviceName}
+        /**
+         * Get this object properties
+         * GET /sslGateway/{serviceName}
+         */
         $get(): Promise<sslGateway.SslGateway>;
-        // PUT /sslGateway/{serviceName}
-        $put(params?: {allowedSource?: string[], displayName?: string, hsts?: boolean, httpsRedirect?: boolean, ipv4?: string, ipv6?: string, metricsToken?: string, offer?: sslGateway.OfferEnum, reverse?: string, serverHttps?: boolean, serviceName?: string, sslConfiguration?: sslGateway.SslConfigurationEnum, state?: sslGateway.StateEnum, zones?: string[]}): Promise<void>;
+        /**
+         * Alter this object properties
+         * PUT /sslGateway/{serviceName}
+         */
+        $put(params?: { allowedSource?: string[], displayName?: string, hsts?: boolean, httpsRedirect?: boolean, ipv4?: string, ipv6?: string, metricsToken?: string, offer?: sslGateway.OfferEnum, reverse?: string, serverHttps?: boolean, serviceName?: string, sslConfiguration?: sslGateway.SslConfigurationEnum, state?: sslGateway.StateEnum, zones?: string[] }): Promise<void>;
+        /**
+         * Controle cache
+         */
+        $cache(param?: ICacheOptions): Promise<any>;
         changeContact: {
-            // POST /sslGateway/{serviceName}/changeContact
-            $post(params?: {contactAdmin?: string, contactBilling?: string, contactTech?: string}): Promise<number[]>;
+            /**
+             * Launch a contact change procedure
+             * POST /sslGateway/{serviceName}/changeContact
+             */
+            $post(params?: { contactAdmin?: string, contactBilling?: string, contactTech?: string }): Promise<number[]>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         }
         confirmTermination: {
-            // POST /sslGateway/{serviceName}/confirmTermination
-            $post(params: {commentary?: string, futureUse?: service.TerminationFutureUseEnum, reason?: service.TerminationReasonEnum, token: string}): Promise<string>;
+            /**
+             * Confirm termination of your service
+             * POST /sslGateway/{serviceName}/confirmTermination
+             */
+            $post(params: { commentary?: string, futureUse?: service.TerminationFutureUseEnum, reason?: service.TerminationReasonEnum, token: string }): Promise<string>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         }
         domain: {
-            // GET /sslGateway/{serviceName}/domain
+            /**
+             * Domains attached to your SSL Gateway
+             * GET /sslGateway/{serviceName}/domain
+             */
             $get(): Promise<number[]>;
-            // POST /sslGateway/{serviceName}/domain
-            $post(params: {domain: string}): Promise<sslGateway.Domain>;
+            /**
+             * Attach a new domain to your SSL Gateway
+             * POST /sslGateway/{serviceName}/domain
+             */
+            $post(params: { domain: string }): Promise<sslGateway.Domain>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
             $(id: number): {
-                // DELETE /sslGateway/{serviceName}/domain/{id}
+                /**
+                 * Detach a domain from your SSL Gateway
+                 * DELETE /sslGateway/{serviceName}/domain/{id}
+                 */
                 $delete(): Promise<void>;
-                // GET /sslGateway/{serviceName}/domain/{id}
+                /**
+                 * Get this object properties
+                 * GET /sslGateway/{serviceName}/domain/{id}
+                 */
                 $get(): Promise<sslGateway.Domain>;
+                /**
+                 * Controle cache
+                 */
+                $cache(param?: ICacheOptions): Promise<any>;
             };
         }
         natIp: {
-            // GET /sslGateway/{serviceName}/natIp
+            /**
+             * Ip subnet used by OVH to nat requests to your SSL Gateway backends.
+             * GET /sslGateway/{serviceName}/natIp
+             */
             $get(): Promise<sslGateway.NatIps[]>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         }
         renewCertificate: {
-            // POST /sslGateway/{serviceName}/renewCertificate
-            $post(params?: {domain?: string}): Promise<string[]>;
+            /**
+             * Renew your SSL certificates
+             * POST /sslGateway/{serviceName}/renewCertificate
+             */
+            $post(params?: { domain?: string }): Promise<string[]>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         }
         server: {
-            // GET /sslGateway/{serviceName}/server
+            /**
+             * Servers attached to your SSL Gateway
+             * GET /sslGateway/{serviceName}/server
+             */
             $get(): Promise<number[]>;
-            // POST /sslGateway/{serviceName}/server
-            $post(params: {address: string, port: number}): Promise<sslGateway.Server>;
+            /**
+             * Add a new server to your SSL Gateway
+             * POST /sslGateway/{serviceName}/server
+             */
+            $post(params: { address: string, port: number }): Promise<sslGateway.Server>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
             $(id: number): {
-                // DELETE /sslGateway/{serviceName}/server/{id}
+                /**
+                 * Remove a server
+                 * DELETE /sslGateway/{serviceName}/server/{id}
+                 */
                 $delete(): Promise<void>;
-                // GET /sslGateway/{serviceName}/server/{id}
+                /**
+                 * Get this object properties
+                 * GET /sslGateway/{serviceName}/server/{id}
+                 */
                 $get(): Promise<sslGateway.Server>;
-                // PUT /sslGateway/{serviceName}/server/{id}
-                $put(params?: {address?: string, id?: number, port?: number, state?: sslGateway.ServerStateEnum}): Promise<void>;
+                /**
+                 * Alter this object properties
+                 * PUT /sslGateway/{serviceName}/server/{id}
+                 */
+                $put(params?: { address?: string, id?: number, port?: number, state?: sslGateway.ServerStateEnum }): Promise<void>;
+                /**
+                 * Controle cache
+                 */
+                $cache(param?: ICacheOptions): Promise<any>;
             };
         }
         serviceInfos: {
-            // GET /sslGateway/{serviceName}/serviceInfos
+            /**
+             * Get this object properties
+             * GET /sslGateway/{serviceName}/serviceInfos
+             */
             $get(): Promise<services.Service>;
-            // PUT /sslGateway/{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<void>;
+            /**
+             * Alter this object properties
+             * PUT /sslGateway/{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<void>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         }
         task: {
-            // GET /sslGateway/{serviceName}/task
+            /**
+             * Task for this SSL Gateway
+             * GET /sslGateway/{serviceName}/task
+             */
             $get(): Promise<number[]>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
             $(id: number): {
-                // GET /sslGateway/{serviceName}/task/{id}
+                /**
+                 * Get this object properties
+                 * GET /sslGateway/{serviceName}/task/{id}
+                 */
                 $get(): Promise<sslGateway.Task>;
+                /**
+                 * Controle cache
+                 */
+                $cache(param?: ICacheOptions): Promise<any>;
             };
         }
         terminate: {
-            // POST /sslGateway/{serviceName}/terminate
+            /**
+             * Terminate your service
+             * POST /sslGateway/{serviceName}/terminate
+             */
             $post(): Promise<string>;
+            /**
+             * Controle cache
+             */
+            $cache(param?: ICacheOptions): Promise<any>;
         }
     };
-// Api
-  /**
-   * Operations about the SSLGATEWAY service
-   * List available services
-   */
-  get(path: '/sslGateway'): () => Promise<string[]>;
-  /**
-   * Your SSL Gateway
-   * Get this object properties
-   */
-  get(path: '/sslGateway/{serviceName}'): (params: {serviceName: string}) => Promise<sslGateway.SslGateway>;
-  /**
-   * List the sslGateway.Domain objects
-   * Domains attached to your SSL Gateway
-   */
-  get(path: '/sslGateway/{serviceName}/domain'): (params: {serviceName: string}) => Promise<number[]>;
-  /**
-   * Domain attached to an SSL Gateway
-   * Get this object properties
-   */
-  get(path: '/sslGateway/{serviceName}/domain/{id}'): (params: {id: number, serviceName: string}) => Promise<sslGateway.Domain>;
-  /**
-   * natIp operations
-   * Ip subnet used by OVH to nat requests to your SSL Gateway backends.
-   */
-  get(path: '/sslGateway/{serviceName}/natIp'): (params: {serviceName: string}) => Promise<sslGateway.NatIps[]>;
-  /**
-   * List the sslGateway.Server objects
-   * Servers attached to your SSL Gateway
-   */
-  get(path: '/sslGateway/{serviceName}/server'): (params: {serviceName: string}) => Promise<number[]>;
-  /**
-   * Server attached to an SSL Gateway
-   * Get this object properties
-   */
-  get(path: '/sslGateway/{serviceName}/server/{id}'): (params: {id: number, serviceName: string}) => Promise<sslGateway.Server>;
-  /**
-   * Details about a Service
-   * Get this object properties
-   */
-  get(path: '/sslGateway/{serviceName}/serviceInfos'): (params: {serviceName: string}) => Promise<services.Service>;
-  /**
-   * List the sslGateway.Task objects
-   * Task for this SSL Gateway
-   */
-  get(path: '/sslGateway/{serviceName}/task'): (params: {serviceName: string}) => Promise<number[]>;
-  /**
-   * SSL Gateway tasks
-   * Get this object properties
-   */
-  get(path: '/sslGateway/{serviceName}/task/{id}'): (params: {id: number, serviceName: string}) => Promise<sslGateway.Task>;
-  /**
-   * List of zone available for an SSL Gateway
-   * List of zone available for an SSL Gateway
-   */
-  get(path: '/sslGateway/availableZones'): () => Promise<string[]>;
-  /**
-   * Check domain eligibility. Return list of eligible IP(s) for this domain.
-   * Check domain eligibility. Return list of eligible IP(s) for this domain.
-   */
-  get(path: '/sslGateway/eligibility'): (params: {domain: string}) => Promise<sslGateway.EligibilityStatus>;
-  /**
-   * Your SSL Gateway
-   * Alter this object properties
-   */
-  put(path: '/sslGateway/{serviceName}'): (params: {serviceName: string, allowedSource?: string[], displayName?: string, hsts?: boolean, httpsRedirect?: boolean, ipv4?: string, ipv6?: string, metricsToken?: string, offer?: sslGateway.OfferEnum, reverse?: string, serverHttps?: boolean, sslConfiguration?: sslGateway.SslConfigurationEnum, state?: sslGateway.StateEnum, zones?: string[]}) => Promise<void>;
-  /**
-   * Server attached to an SSL Gateway
-   * Alter this object properties
-   */
-  put(path: '/sslGateway/{serviceName}/server/{id}'): (params: {id: number, serviceName: string, address?: string, port?: number, state?: sslGateway.ServerStateEnum}) => Promise<void>;
-  /**
-   * Details about a Service
-   * Alter this object properties
-   */
-  put(path: '/sslGateway/{serviceName}/serviceInfos'): (params: {serviceName: string, 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<void>;
-  /**
-   * Change the contacts of this service
-   * Launch a contact change procedure
-   */
-  post(path: '/sslGateway/{serviceName}/changeContact'): (params: {serviceName: string, contactAdmin?: string, contactBilling?: string, contactTech?: string}) => Promise<number[]>;
-  /**
-   * Confirm termination of your service
-   * Confirm termination of your service
-   */
-  post(path: '/sslGateway/{serviceName}/confirmTermination'): (params: {serviceName: string, commentary?: string, futureUse?: service.TerminationFutureUseEnum, reason?: service.TerminationReasonEnum, token: string}) => Promise<string>;
-  /**
-   * List the sslGateway.Domain objects
-   * Attach a new domain to your SSL Gateway
-   */
-  post(path: '/sslGateway/{serviceName}/domain'): (params: {serviceName: string, domain: string}) => Promise<sslGateway.Domain>;
-  /**
-   * renewCertificate operations
-   * Renew your SSL certificates
-   */
-  post(path: '/sslGateway/{serviceName}/renewCertificate'): (params: {serviceName: string, domain?: string}) => Promise<string[]>;
-  /**
-   * List the sslGateway.Server objects
-   * Add a new server to your SSL Gateway
-   */
-  post(path: '/sslGateway/{serviceName}/server'): (params: {serviceName: string, address: string, port: number}) => Promise<sslGateway.Server>;
-  /**
-   * Terminate your service
-   * Terminate your service
-   */
-  post(path: '/sslGateway/{serviceName}/terminate'): (params: {serviceName: string}) => Promise<string>;
-  /**
-   * Domain attached to an SSL Gateway
-   * Detach a domain from your SSL Gateway
-   */
-  delete(path: '/sslGateway/{serviceName}/domain/{id}'): (params: {id: number, serviceName: string}) => Promise<void>;
-  /**
-   * Server attached to an SSL Gateway
-   * Remove a server
-   */
-  delete(path: '/sslGateway/{serviceName}/server/{id}'): (params: {id: number, serviceName: string}) => Promise<void>;
 }

package.json

 {
     "name": "@ovh-api/ssl-gateway",
     "description": "Add typing to to ovh api ssl-gateway",
-    "version": "2.0.13",
+    "version": "3.0.0",
     "typings": "index.d.ts",
@@ -9,3 +9,3 @@ "license": "MIT",
     "dependencies": {
-        "@ovh-api/common": "^1.3.0"
+        "@ovh-api/common": "^3.0.0"
     },
@@ -24,3 +24,8 @@ "publishConfig": {
     },
-    "gitHead": "976c58962d96443ca7e6c6b64ca63b3c43c62ff8"
+    "files": [
+        "index.js",
+        "index.d.ts",
+        "index.ts"
+    ],
+    "gitHead": "d24f9e1e7d19630a6838b3640dffef10328a6723"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

833

increased by11.96%

Worsened metrics

Total package byte prevSize

29930

decreased by-0.57%

Number of package files

5

decreased by-16.67%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@ovh-api/common@3.1.2(transitive)

• - Removed@ovh-api/common@1.3.0(transitive)

• Updated@ovh-api/common@^3.0.0