@ovh-api/ssl-gateway
Advanced tools
Comparing version 4.0.4 to 5.0.0
167
index.d.ts
import type { CacheAction, ICacheOptions, OvhRequestable } from '@ovh-api/common'; | ||
/** | ||
@@ -6,3 +7,3 @@ * START API /sslGateway Models | ||
*/ | ||
export declare namespace iam { | ||
export namespace iam { | ||
/** | ||
@@ -12,11 +13,9 @@ * IAM resource metadata embedded in services models | ||
*/ | ||
interface ResourceMetadata { | ||
export interface ResourceMetadata { | ||
displayName?: string; | ||
id: string; | ||
tags?: { | ||
[key: string]: string; | ||
}; | ||
tags?: { [key: string]: string }; | ||
urn: string; | ||
} | ||
namespace resource { | ||
export namespace resource { | ||
/** | ||
@@ -26,7 +25,7 @@ * Resource tag filter | ||
*/ | ||
interface TagFilter { | ||
export interface TagFilter { | ||
operator?: iam.resource.TagFilter.OperatorEnum; | ||
value: string; | ||
} | ||
namespace TagFilter { | ||
export namespace TagFilter { | ||
/** | ||
@@ -36,7 +35,7 @@ * Operator that can be used in order to filter resources tags | ||
*/ | ||
type OperatorEnum = "EQ"; | ||
export type OperatorEnum = "EQ" | ||
} | ||
} | ||
} | ||
export declare namespace service { | ||
export namespace service { | ||
/** | ||
@@ -46,3 +45,3 @@ * Map a possible renew for a specific service | ||
*/ | ||
interface RenewType { | ||
export interface RenewType { | ||
automatic: boolean; | ||
@@ -58,7 +57,7 @@ deleteAtExpiration: boolean; | ||
*/ | ||
type RenewalTypeEnum = "automaticForcedProduct" | "automaticV2012" | "automaticV2014" | "automaticV2016" | "manual" | "oneShot" | "option"; | ||
export type RenewalTypeEnum = "automaticForcedProduct" | "automaticV2012" | "automaticV2014" | "automaticV2016" | "manual" | "oneShot" | "option" | ||
/** | ||
* type fullname: service.StateEnum | ||
*/ | ||
type StateEnum = "expired" | "inCreation" | "ok" | "pendingDebt" | "unPaid"; | ||
export type StateEnum = "expired" | "inCreation" | "ok" | "pendingDebt" | "unPaid" | ||
/** | ||
@@ -68,3 +67,3 @@ * All future uses you can provide for a service termination | ||
*/ | ||
type TerminationFutureUseEnum = "NOT_REPLACING_SERVICE" | "OTHER" | "SUBSCRIBE_AN_OTHER_SERVICE" | "SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR" | "SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR"; | ||
export type TerminationFutureUseEnum = "NOT_REPLACING_SERVICE" | "OTHER" | "SUBSCRIBE_AN_OTHER_SERVICE" | "SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR" | "SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR" | ||
/** | ||
@@ -74,5 +73,5 @@ * All reasons you can provide for a service termination | ||
*/ | ||
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 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 { | ||
export namespace services { | ||
/** | ||
@@ -82,3 +81,3 @@ * Details about a Service | ||
*/ | ||
interface Service { | ||
export interface Service { | ||
canDeleteAtExpiration: boolean; | ||
@@ -99,3 +98,3 @@ contactAdmin: string; | ||
} | ||
export declare namespace sslGateway { | ||
export namespace sslGateway { | ||
/** | ||
@@ -105,3 +104,3 @@ * Domain attached to an SSL Gateway | ||
*/ | ||
interface Domain { | ||
export interface Domain { | ||
domain: string; | ||
@@ -115,3 +114,3 @@ id: number; | ||
*/ | ||
type DomainStateEnum = "creating" | "deleted" | "deleting" | "http-only" | "internal" | "ok"; | ||
export type DomainStateEnum = "creating" | "deleted" | "deleting" | "http-only" | "internal" | "ok" | ||
/** | ||
@@ -121,3 +120,3 @@ * A structure describing the eligibility status of a domain | ||
*/ | ||
interface EligibilityStatus { | ||
export interface EligibilityStatus { | ||
domain: string; | ||
@@ -132,3 +131,3 @@ ip6s: string[]; | ||
*/ | ||
interface NatIps { | ||
export interface NatIps { | ||
ip: string[]; | ||
@@ -141,3 +140,3 @@ zone: string; | ||
*/ | ||
type OfferEnum = "advanced" | "enterprise" | "free" | "internal"; | ||
export type OfferEnum = "advanced" | "enterprise" | "free" | "internal" | ||
/** | ||
@@ -147,3 +146,3 @@ * Server attached to an SSL Gateway | ||
*/ | ||
interface Server { | ||
export interface Server { | ||
address: string; | ||
@@ -158,3 +157,3 @@ id: number; | ||
*/ | ||
type ServerStateEnum = "creating" | "deleted" | "deleting" | "internal" | "ok" | "updating"; | ||
export type ServerStateEnum = "creating" | "deleted" | "deleting" | "internal" | "ok" | "updating" | ||
/** | ||
@@ -164,3 +163,3 @@ * Possible values for ssl ciphers | ||
*/ | ||
type SslConfigurationEnum = "intermediate" | "internal" | "modern"; | ||
export type SslConfigurationEnum = "intermediate" | "internal" | "modern" | ||
/** | ||
@@ -170,3 +169,3 @@ * Your SSL Gateway | ||
*/ | ||
interface SslGateway { | ||
export interface SslGateway { | ||
allowedSource?: string[]; | ||
@@ -191,3 +190,3 @@ displayName?: string; | ||
*/ | ||
interface SslGatewayWithIAM { | ||
export interface SslGatewayWithIAM { | ||
allowedSource?: string[]; | ||
@@ -213,3 +212,3 @@ displayName?: string; | ||
*/ | ||
type StateEnum = "creating" | "deleted" | "deleting" | "http-only" | "internal" | "ok" | "suspended" | "upgrading"; | ||
export type StateEnum = "creating" | "deleted" | "deleting" | "http-only" | "internal" | "ok" | "suspended" | "upgrading" | ||
/** | ||
@@ -219,3 +218,3 @@ * SSL Gateway tasks | ||
*/ | ||
interface Task { | ||
export interface Task { | ||
action: sslGateway.TaskActionEnum; | ||
@@ -231,3 +230,3 @@ creationDate: string; | ||
*/ | ||
type TaskActionEnum = "addDomain" | "addPaidCertificate" | "addServer" | "createService" | "deleteDomain" | "deleteServer" | "deleteService" | "internalTask" | "updateServer" | "updateService" | "upgrade"; | ||
export type TaskActionEnum = "addDomain" | "addPaidCertificate" | "addServer" | "createService" | "deleteDomain" | "deleteServer" | "deleteService" | "internalTask" | "updateServer" | "updateService" | "upgrade" | ||
/** | ||
@@ -237,10 +236,5 @@ * Possible task status | ||
*/ | ||
type TaskStatusEnum = "blocked" | "cancelled" | "doing" | "done" | "error" | "paused" | "todo"; | ||
export type TaskStatusEnum = "blocked" | "cancelled" | "doing" | "done" | "error" | "paused" | "todo" | ||
} | ||
/** | ||
* END API /sslGateway Models | ||
*/ | ||
export declare function proxySslGateway(ovhEngine: OvhRequestable): SslGateway; | ||
export default proxySslGateway; | ||
/** | ||
* Api model for /sslGateway | ||
@@ -253,5 +247,3 @@ */ | ||
*/ | ||
$get(params?: { | ||
iamTags?: any; | ||
}): Promise<string[]>; | ||
$get(params?: { iamTags?: any }): Promise<string[]>; | ||
/** | ||
@@ -271,3 +263,3 @@ * Controle cache | ||
$cache(param?: ICacheOptions | CacheAction): Promise<any>; | ||
}; | ||
} | ||
eligibility: { | ||
@@ -278,5 +270,3 @@ /** | ||
*/ | ||
$get(params: { | ||
domain: string; | ||
}): Promise<sslGateway.EligibilityStatus>; | ||
$get(params: { domain: string }): Promise<sslGateway.EligibilityStatus>; | ||
/** | ||
@@ -286,3 +276,3 @@ * Controle cache | ||
$cache(param?: ICacheOptions | CacheAction): Promise<any>; | ||
}; | ||
} | ||
$(serviceName: string): { | ||
@@ -298,18 +288,3 @@ /** | ||
*/ | ||
$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>; | ||
$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>; | ||
/** | ||
@@ -324,8 +299,4 @@ * Controle cache | ||
*/ | ||
$post(params?: { | ||
contactAdmin?: string; | ||
contactBilling?: string; | ||
contactTech?: string; | ||
}): Promise<number[]>; | ||
}; | ||
$post(params?: { contactAdmin?: string, contactBilling?: string, contactTech?: string }): Promise<number[]>; | ||
} | ||
confirmTermination: { | ||
@@ -336,9 +307,4 @@ /** | ||
*/ | ||
$post(params: { | ||
commentary?: string; | ||
futureUse?: service.TerminationFutureUseEnum; | ||
reason?: service.TerminationReasonEnum; | ||
token: string; | ||
}): Promise<string>; | ||
}; | ||
$post(params: { commentary?: string, futureUse?: service.TerminationFutureUseEnum, reason?: service.TerminationReasonEnum, token: string }): Promise<string>; | ||
} | ||
domain: { | ||
@@ -354,5 +320,3 @@ /** | ||
*/ | ||
$post(params: { | ||
domain: string; | ||
}): Promise<sslGateway.Domain>; | ||
$post(params: { domain: string }): Promise<sslGateway.Domain>; | ||
/** | ||
@@ -378,3 +342,3 @@ * Controle cache | ||
}; | ||
}; | ||
} | ||
natIp: { | ||
@@ -390,3 +354,3 @@ /** | ||
$cache(param?: ICacheOptions | CacheAction): Promise<any>; | ||
}; | ||
} | ||
renewCertificate: { | ||
@@ -397,6 +361,4 @@ /** | ||
*/ | ||
$post(params?: { | ||
domain?: string; | ||
}): Promise<string[]>; | ||
}; | ||
$post(params?: { domain?: string }): Promise<string[]>; | ||
} | ||
server: { | ||
@@ -412,6 +374,3 @@ /** | ||
*/ | ||
$post(params: { | ||
address: string; | ||
port: number; | ||
}): Promise<sslGateway.Server>; | ||
$post(params: { address: string, port: number }): Promise<sslGateway.Server>; | ||
/** | ||
@@ -436,8 +395,3 @@ * Controle cache | ||
*/ | ||
$put(params?: { | ||
address?: string; | ||
id?: number; | ||
port?: number; | ||
state?: sslGateway.ServerStateEnum; | ||
}): Promise<void>; | ||
$put(params?: { address?: string, id?: number, port?: number, state?: sslGateway.ServerStateEnum }): Promise<void>; | ||
/** | ||
@@ -448,3 +402,3 @@ * Controle cache | ||
}; | ||
}; | ||
} | ||
serviceInfos: { | ||
@@ -460,17 +414,3 @@ /** | ||
*/ | ||
$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>; | ||
$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>; | ||
/** | ||
@@ -480,3 +420,3 @@ * Controle cache | ||
$cache(param?: ICacheOptions | CacheAction): Promise<any>; | ||
}; | ||
} | ||
task: { | ||
@@ -503,3 +443,3 @@ /** | ||
}; | ||
}; | ||
} | ||
terminate: { | ||
@@ -511,4 +451,7 @@ /** | ||
$post(): Promise<string>; | ||
}; | ||
} | ||
}; | ||
} | ||
export declare function proxySslGateway(ovhEngine: OvhRequestable): SslGateway; | ||
export default proxySslGateway; |
{ | ||
"name": "@ovh-api/ssl-gateway", | ||
"description": "Add typing to to ovh api ssl-gateway", | ||
"version": "4.0.4", | ||
"version": "5.0.0", | ||
"keywords": [ | ||
@@ -35,14 +35,9 @@ "ovh", | ||
}, | ||
"scripts": { | ||
"build": "tsc --pretty --project . && tsc --pretty --project tsconfig-cjs.json", | ||
"prepare": "npm run build" | ||
}, | ||
"files": [ | ||
"cjs", | ||
"index.ts", | ||
"index.js", | ||
"index.d.ts" | ||
"./index.d.ts", | ||
"./index.cjs", | ||
"./index.mjs" | ||
], | ||
"type": "module", | ||
"gitHead": "dc82efac55b8ef00d0a6c45c9c2dca9d1d24590f" | ||
"gitHead": "d4e853b88536adac216447633fc758d540eb2cab" | ||
} |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
18487
6
433