@dopplerhq/node-sdk
Advanced tools
Comparing version 1.0.2 to 1.1.0
1603
dist/index.d.ts
@@ -0,7 +1,6 @@ | ||
interface Headers extends Record<string, string> { | ||
} | ||
/** | ||
* Defines the basic operations for an HTTP client. | ||
*/ | ||
interface Headers { | ||
[key: string]: string; | ||
} | ||
interface HTTPClient { | ||
@@ -15,11 +14,35 @@ get(url: string, input: any, headers: Headers, retry?: boolean): Promise<any>; | ||
declare class HTTPLibrary implements HTTPClient { | ||
readonly userAgentHeader: Headers; | ||
readonly retryAttempts: number; | ||
readonly retryDelayMs: number; | ||
private static readonly responseMapper; | ||
private readonly requestMapper; | ||
get(url: string, input: any, headers: Headers, retry?: boolean): Promise<any>; | ||
post(url: string, input: any, headers: Headers, retry?: boolean): Promise<any>; | ||
delete(url: string, input: any, headers: Headers, retry?: boolean): Promise<any>; | ||
put(url: string, input: any, headers: Headers, retry?: boolean): Promise<any>; | ||
patch(url: string, input: any, headers: Headers, retry?: boolean): Promise<any>; | ||
retry(retries: number, callbackFn: () => any, delay?: number): Promise<any>; | ||
private static handleResponse; | ||
private static httpRequest; | ||
private getUserAgentHeader; | ||
/** | ||
*Converts keys in an object using a provided JSON mapper. | ||
* @param {any} obj - The object to convert keys for. | ||
* @param {Object} jsonMapper - The JSON mapper containing key mappings. | ||
* @returns {any} - The object with converted keys. | ||
*/ | ||
private static convertKeysWithMapper; | ||
} | ||
declare class BaseService { | ||
private userAgent; | ||
baseUrl: string; | ||
http: HTTPClient; | ||
private bearer; | ||
setToken(bearer: string): void; | ||
getAuthorizationHeader(): object; | ||
httpClient: HTTPLibrary; | ||
private accessToken; | ||
private accessTokenPrefix; | ||
setAccessToken(accessToken: string): void; | ||
getAuthorizationHeader(): Headers; | ||
setBaseUrl(url: string): void; | ||
constructor(bearerToken?: string); | ||
constructor(accessToken?: string); | ||
static patternMatching(value: string, pattern: string, variableName: string): string; | ||
@@ -34,94 +57,150 @@ static urlEncode: (input: { | ||
declare namespace ProjectsList200Response { | ||
type Id = string; | ||
declare namespace GetResponse { | ||
type Name = string; | ||
type Slug = string; | ||
type Name = string; | ||
type Description = string; | ||
type CreatedAt = string; | ||
type Identifier = string; | ||
type Projects = { | ||
id?: Id; | ||
name?: Name; | ||
slug?: Slug; | ||
name?: Name; | ||
description?: Description; | ||
created_at?: CreatedAt; | ||
role?: Role; | ||
}[]; | ||
type Slug1 = string; | ||
type Type = string; | ||
type Members = { | ||
slug?: Slug1; | ||
type_?: Type; | ||
}[]; | ||
interface Model extends BaseModel { | ||
page?: number; | ||
group?: Group; | ||
} | ||
interface Group { | ||
name?: string; | ||
slug?: string; | ||
created_at?: string; | ||
default_project_role?: DefaultProjectRole; | ||
projects?: Projects; | ||
members?: Members; | ||
} | ||
interface DefaultProjectRole { | ||
identifier?: string; | ||
} | ||
interface Role { | ||
identifier?: Identifier; | ||
} | ||
} | ||
declare namespace ProjectsCreateRequest { | ||
declare namespace UpdateRequest { | ||
interface Model extends BaseModel { | ||
name?: string; | ||
/** | ||
* Name of project | ||
* Identifier of the project role | ||
*/ | ||
name: string; | ||
/** | ||
* Description of project | ||
*/ | ||
description?: string; | ||
default_project_role?: string; | ||
} | ||
} | ||
declare namespace ProjectsCreate200Response { | ||
declare namespace UpdateResponse { | ||
type Name = string; | ||
type Slug = string; | ||
type Identifier = string; | ||
type Projects = { | ||
name?: Name; | ||
slug?: Slug; | ||
role?: Role; | ||
}[]; | ||
type Slug1 = string; | ||
type Type = string; | ||
type Members = { | ||
slug?: Slug1; | ||
type_?: Type; | ||
}[]; | ||
interface Model extends BaseModel { | ||
project?: Project; | ||
group?: Group; | ||
} | ||
interface Project { | ||
id?: string; | ||
interface Group { | ||
name?: string; | ||
description?: string; | ||
slug?: string; | ||
created_at?: string; | ||
default_project_role?: DefaultProjectRole; | ||
projects?: Projects; | ||
members?: Members; | ||
} | ||
interface DefaultProjectRole { | ||
identifier?: string; | ||
} | ||
interface Role { | ||
identifier?: Identifier; | ||
} | ||
} | ||
declare namespace ProjectsGet200Response { | ||
declare namespace DeleteRequest { | ||
interface Model extends BaseModel { | ||
project?: Project; | ||
/** | ||
* An IP address or CIDR range | ||
*/ | ||
ip: string; | ||
} | ||
interface Project { | ||
id?: string; | ||
name?: string; | ||
description?: string; | ||
created_at?: string; | ||
} | ||
declare namespace ListResponse { | ||
type Name = string; | ||
type Slug = string; | ||
type CreatedAt = string; | ||
type Identifier = string; | ||
type Groups = { | ||
name?: Name; | ||
slug?: Slug; | ||
created_at?: CreatedAt; | ||
default_project_role?: DefaultProjectRole; | ||
}[]; | ||
interface Model extends BaseModel { | ||
groups?: Groups; | ||
} | ||
interface DefaultProjectRole { | ||
identifier?: Identifier; | ||
} | ||
} | ||
declare namespace ProjectsUpdateRequest { | ||
declare namespace CreateRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
/** | ||
* Name of the project. | ||
*/ | ||
name: string; | ||
/** | ||
* Description of the project. | ||
* Identifier of the project role | ||
*/ | ||
description?: string; | ||
default_project_role?: string; | ||
} | ||
} | ||
declare namespace ProjectsUpdate200Response { | ||
declare namespace CreateResponse { | ||
type Name = string; | ||
type Slug = string; | ||
type Identifier = string; | ||
type Projects = { | ||
name?: Name; | ||
slug?: Slug; | ||
role?: Role; | ||
}[]; | ||
type Slug1 = string; | ||
type Type = string; | ||
type Members = { | ||
slug?: Slug1; | ||
type_?: Type; | ||
}[]; | ||
interface Model extends BaseModel { | ||
project?: Project; | ||
group?: Group; | ||
} | ||
interface Project { | ||
id?: string; | ||
interface Group { | ||
name?: string; | ||
description?: string; | ||
slug?: string; | ||
created_at?: string; | ||
default_project_role?: DefaultProjectRole; | ||
projects?: Projects; | ||
members?: Members; | ||
} | ||
} | ||
declare namespace ProjectsDeleteRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
interface DefaultProjectRole { | ||
identifier?: string; | ||
} | ||
interface Role { | ||
identifier?: Identifier; | ||
} | ||
} | ||
@@ -131,22 +210,2 @@ | ||
/** | ||
* @summary List | ||
* @description Projects | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.page - Page number | ||
* @param optionalParams.perPage - Items per page | ||
* @returns {Promise<ProjectsList200Response.Model>} - The promise with the result | ||
*/ | ||
list(optionalParams?: { | ||
page?: number; | ||
perPage?: number; | ||
}): Promise<ProjectsList200Response.Model>; | ||
/** | ||
* @summary Create | ||
* @description Project | ||
* @returns {Promise<ProjectsCreate200Response.Model>} - The promise with the result | ||
*/ | ||
create(input: ProjectsCreateRequest.Model): Promise<ProjectsCreate200Response.Model>; | ||
/** | ||
* @summary Retrieve | ||
@@ -156,5 +215,5 @@ * @description Project | ||
* @param project Unique identifier for the project object. | ||
* @returns {Promise<ProjectsGet200Response.Model>} - The promise with the result | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(project: string): Promise<ProjectsGet200Response.Model>; | ||
get(project: string): Promise<GetResponse.Model>; | ||
/** | ||
@@ -164,5 +223,5 @@ * @summary Update | ||
* @returns {Promise<ProjectsUpdate200Response.Model>} - The promise with the result | ||
* @returns {Promise<UpdateResponse.Model>} - The promise with the result | ||
*/ | ||
update(input: ProjectsUpdateRequest.Model): Promise<ProjectsUpdate200Response.Model>; | ||
update(input: UpdateRequest.Model): Promise<UpdateResponse.Model>; | ||
/** | ||
@@ -174,334 +233,27 @@ * @summary Delete | ||
*/ | ||
delete(input: ProjectsDeleteRequest.Model): Promise<any>; | ||
} | ||
declare namespace SecretsUpdateRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
/** | ||
* Name of the config object. | ||
*/ | ||
config: string; | ||
secrets: Secrets; | ||
} | ||
delete(input: DeleteRequest.Model): Promise<any>; | ||
/** | ||
* Object of secrets you would like to save to the config. Try it with the sample secrets below: | ||
*/ | ||
interface Secrets { | ||
STRIPE: string; | ||
ALGOLIA?: string; | ||
DATABASE?: string; | ||
} | ||
} | ||
declare namespace SecretsUpdate200Response { | ||
interface Model extends BaseModel { | ||
secrets?: Secrets; | ||
} | ||
interface Secrets { | ||
STRIPE?: Stripe; | ||
ALGOLIA?: Algolia; | ||
DATABASE?: Database; | ||
} | ||
interface Stripe { | ||
raw?: string; | ||
computed?: string; | ||
note?: string; | ||
} | ||
interface Algolia { | ||
raw?: string; | ||
computed?: string; | ||
note?: string; | ||
} | ||
interface Database { | ||
raw?: string; | ||
computed?: string; | ||
note?: string; | ||
} | ||
} | ||
declare namespace SecretsGet200Response { | ||
interface Model extends BaseModel { | ||
name?: string; | ||
value?: Value; | ||
} | ||
interface Value { | ||
raw?: string; | ||
computed?: string; | ||
note?: string; | ||
} | ||
} | ||
declare namespace SecretsDownload200Response { | ||
interface Model extends BaseModel { | ||
STRIPE?: string; | ||
ALGOLIA?: string; | ||
DATABASE?: string; | ||
USER?: string; | ||
} | ||
} | ||
declare namespace SecretsListNames200Response { | ||
type Names = string[]; | ||
interface Model extends BaseModel { | ||
names?: Names; | ||
} | ||
} | ||
declare namespace SecretsUpdateNoteRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
/** | ||
* Name of the config object. | ||
*/ | ||
config: string; | ||
secret: string; | ||
note: string; | ||
} | ||
} | ||
declare namespace SecretsUpdateNote200Response { | ||
interface Model extends BaseModel { | ||
secret?: string; | ||
note?: string; | ||
} | ||
} | ||
declare class SecretsService extends BaseService { | ||
/** | ||
* @summary List | ||
* @description Secrets | ||
* @description Projects | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.accepts - Available options are: **application/json**, **text/plain** | ||
* @param optionalParams.includeDynamicSecrets - Whether or not to issue leases and include dynamic secret values for the config | ||
* @param optionalParams.dynamicSecretsTtlSec - The number of seconds until dynamic leases expire. Must be used with `include_dynamic_secrets`. Defaults to 1800 (30 minutes). | ||
* @param optionalParams.secrets - A comma-separated list of secrets to include in the response | ||
* @param optionalParams.includeManagedSecrets - Whether to include Doppler's auto-generated (managed) secrets | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
list(project: string, config: string, optionalParams?: { | ||
accepts?: string; | ||
includeDynamicSecrets?: boolean; | ||
dynamicSecretsTtlSec?: number; | ||
secrets?: string; | ||
includeManagedSecrets?: boolean; | ||
}): Promise<any>; | ||
/** | ||
* @summary Update | ||
* @description Secrets | ||
* @returns {Promise<SecretsUpdate200Response.Model>} - The promise with the result | ||
*/ | ||
update(input: SecretsUpdateRequest.Model): Promise<SecretsUpdate200Response.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @description Secret | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param name Name of the secret. | ||
* @returns {Promise<SecretsGet200Response.Model>} - The promise with the result | ||
*/ | ||
get(project: string, config: string, name: string): Promise<SecretsGet200Response.Model>; | ||
/** | ||
* @summary Download | ||
* @description Download Secrets | ||
* @param project Unique identifier for the project object. Not required if using a Service Token. | ||
* @param config Name of the config object. Not required if using a Service Token. | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.format - Needed input variable | ||
* @param optionalParams.nameTransformer - Transform secret names to a different case | ||
* @param optionalParams.includeDynamicSecrets - Whether or not to issue leases and include dynamic secret values for the config | ||
* @param optionalParams.dynamicSecretsTtlSec - The number of seconds until dynamic leases expire. Must be used with `include_dynamic_secrets`. Defaults to 1800 (30 minutes). | ||
* @returns {Promise<SecretsDownload200Response.Model>} - The promise with the result | ||
*/ | ||
download(project: string, config: string, optionalParams?: { | ||
format?: string; | ||
nameTransformer?: string; | ||
includeDynamicSecrets?: boolean; | ||
dynamicSecretsTtlSec?: number; | ||
}): Promise<SecretsDownload200Response.Model>; | ||
/** | ||
* @summary List | ||
* @description Secret Names | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.includeDynamicSecrets - Whether or not to issue leases and include dynamic secret values for the config | ||
* @param optionalParams.includeManagedSecrets - Whether to include Doppler's auto-generated (managed) secrets | ||
* @returns {Promise<SecretsListNames200Response.Model>} - The promise with the result | ||
*/ | ||
listNames(project: string, config: string, optionalParams?: { | ||
includeDynamicSecrets?: boolean; | ||
includeManagedSecrets?: boolean; | ||
}): Promise<SecretsListNames200Response.Model>; | ||
/** | ||
* @summary Note | ||
* @description Set a note on a secret | ||
* @returns {Promise<SecretsUpdateNote200Response.Model>} - The promise with the result | ||
*/ | ||
updateNote(input: SecretsUpdateNoteRequest.Model): Promise<SecretsUpdateNote200Response.Model>; | ||
} | ||
declare namespace ConfigLogsList200Response { | ||
type Id = string; | ||
type Text = string; | ||
type Html = string; | ||
type Rollback = boolean; | ||
type CreatedAt = string; | ||
type Config = string; | ||
type Environment = string; | ||
type Project = string; | ||
type Email = string; | ||
type Name = string; | ||
type Username = string; | ||
type ProfileImageUrl = string; | ||
type Logs = { | ||
id?: Id; | ||
text?: Text; | ||
html?: Html; | ||
rollback?: Rollback; | ||
created_at?: CreatedAt; | ||
config?: Config; | ||
environment?: Environment; | ||
project?: Project; | ||
user?: User; | ||
}[]; | ||
interface Model extends BaseModel { | ||
page?: number; | ||
logs?: Logs; | ||
} | ||
interface User { | ||
email?: Email; | ||
name?: Name; | ||
username?: Username; | ||
profile_image_url?: ProfileImageUrl; | ||
} | ||
} | ||
declare namespace ConfigLogsGet200Response { | ||
type Name = string; | ||
type Added = string; | ||
type Diff = { | ||
name?: Name; | ||
added?: Added; | ||
}[]; | ||
interface Model extends BaseModel { | ||
log?: Log; | ||
} | ||
interface Log { | ||
id?: string; | ||
text?: string; | ||
html?: string; | ||
diff?: Diff; | ||
rollback?: boolean; | ||
created_at?: string; | ||
config?: string; | ||
environment?: string; | ||
project?: string; | ||
user?: User; | ||
} | ||
interface User { | ||
email?: string; | ||
name?: string; | ||
username?: string; | ||
profile_image_url?: string; | ||
} | ||
} | ||
declare namespace ConfigLogsRollback200Response { | ||
type Name = string; | ||
type Removed = string; | ||
type Diff = { | ||
name?: Name; | ||
removed?: Removed; | ||
}[]; | ||
interface Model extends BaseModel { | ||
log?: Log; | ||
} | ||
interface Log { | ||
id?: string; | ||
text?: string; | ||
html?: string; | ||
diff?: Diff; | ||
rollback?: boolean; | ||
created_at?: string; | ||
config?: string; | ||
environment?: string; | ||
project?: string; | ||
user?: User; | ||
} | ||
interface User { | ||
email?: string; | ||
name?: string; | ||
username?: string; | ||
profile_image_url?: string; | ||
} | ||
} | ||
declare class ConfigLogsService extends BaseService { | ||
/** | ||
* @summary List | ||
* @description Config Logs | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.page - Page number | ||
* @param optionalParams.perPage - Items per page | ||
* @returns {Promise<ConfigLogsList200Response.Model>} - The promise with the result | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(project: string, config: string, optionalParams?: { | ||
list(optionalParams?: { | ||
page?: number; | ||
perPage?: number; | ||
}): Promise<ConfigLogsList200Response.Model>; | ||
}): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @description Config Log | ||
* @summary Create | ||
* @description Project | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param log Unique identifier for the log object. | ||
* @returns {Promise<ConfigLogsGet200Response.Model>} - The promise with the result | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
get(project: string, config: string, log: string): Promise<ConfigLogsGet200Response.Model>; | ||
/** | ||
* @summary Rollback | ||
* @description Config Log | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param log Unique identifier for the log object. | ||
* @returns {Promise<ConfigLogsRollback200Response.Model>} - The promise with the result | ||
*/ | ||
rollback(project: string, config: string, log: string): Promise<ConfigLogsRollback200Response.Model>; | ||
create(input: CreateRequest.Model): Promise<CreateResponse.Model>; | ||
} | ||
declare namespace EnvironmentsGet200Response { | ||
declare namespace RenameRequest { | ||
interface Model extends BaseModel { | ||
environment?: Environment; | ||
} | ||
interface Environment { | ||
id?: string; | ||
name?: string; | ||
initial_fetch_at?: string; | ||
created_at?: string; | ||
project?: string; | ||
} | ||
} | ||
declare namespace EnvironmentsRenameRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
@@ -518,3 +270,3 @@ * Desired name | ||
declare namespace EnvironmentsRename200Response { | ||
declare namespace RenameResponse { | ||
interface Model extends BaseModel { | ||
@@ -532,62 +284,21 @@ environment?: Environment; | ||
declare namespace EnvironmentsList200Response { | ||
type Id = string; | ||
type Name = string; | ||
type InitialFetchAt = string; | ||
type CreatedAt = string; | ||
type Project = string; | ||
type Environments = { | ||
id?: Id; | ||
name?: Name; | ||
initial_fetch_at?: InitialFetchAt; | ||
created_at?: CreatedAt; | ||
project?: Project; | ||
}[]; | ||
interface Model extends BaseModel { | ||
environments?: Environments; | ||
page?: number; | ||
} | ||
} | ||
declare namespace EnvironmentsCreateRequest { | ||
interface Model extends BaseModel { | ||
name: string; | ||
slug: string; | ||
} | ||
} | ||
declare namespace EnvironmentsCreate200Response { | ||
interface Model extends BaseModel { | ||
environment?: Environment; | ||
} | ||
interface Environment { | ||
id?: string; | ||
name?: string; | ||
initial_fetch_at?: string; | ||
created_at?: string; | ||
project?: string; | ||
} | ||
} | ||
declare class EnvironmentsService extends BaseService { | ||
/** | ||
* @summary Retrieve | ||
* @description Environment | ||
* @summary List | ||
* @description Environments | ||
* @param project The project's name | ||
* @param environment The environment's slug | ||
* @returns {Promise<EnvironmentsGet200Response.Model>} - The promise with the result | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
get(project: string, environment: string): Promise<EnvironmentsGet200Response.Model>; | ||
list(project: string): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Rename | ||
* @summary Create | ||
* @description Environment | ||
* @param project The project's name | ||
* @param environment The environment's slug | ||
* @returns {Promise<EnvironmentsRename200Response.Model>} - The promise with the result | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
rename(input: EnvironmentsRenameRequest.Model, project: string, environment: string): Promise<EnvironmentsRename200Response.Model>; | ||
create(input: CreateRequest.Model, project: string): Promise<CreateResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @summary Retrieve | ||
* @description Environment | ||
@@ -597,49 +308,31 @@ | ||
* @param environment The environment's slug | ||
* @returns {Promise<any>} - The promise with the result | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
delete(project: string, environment: string): Promise<any>; | ||
get(project: string, environment: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary List | ||
* @description Environments | ||
* @summary Rename | ||
* @description Environment | ||
* @param project The project's name | ||
* @returns {Promise<EnvironmentsList200Response.Model>} - The promise with the result | ||
* @param environment The environment's slug | ||
* @returns {Promise<RenameResponse.Model>} - The promise with the result | ||
*/ | ||
list(project: string): Promise<EnvironmentsList200Response.Model>; | ||
rename(input: RenameRequest.Model, project: string, environment: string): Promise<RenameResponse.Model>; | ||
/** | ||
* @summary Create | ||
* @summary Delete | ||
* @description Environment | ||
* @param project The project's name | ||
* @returns {Promise<EnvironmentsCreate200Response.Model>} - The promise with the result | ||
* @param environment The environment's slug | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
create(input: EnvironmentsCreateRequest.Model, project: string): Promise<EnvironmentsCreate200Response.Model>; | ||
delete(project: string, environment: string): Promise<any>; | ||
} | ||
declare namespace ConfigsList200Response { | ||
type Name = string; | ||
type Root = boolean; | ||
type Locked = boolean; | ||
type InitialFetchAt = string; | ||
type LastFetchAt = string; | ||
type CreatedAt = string; | ||
type Environment = string; | ||
type Project = string; | ||
type Configs = { | ||
name?: Name; | ||
root?: Root; | ||
locked?: Locked; | ||
initial_fetch_at?: InitialFetchAt; | ||
last_fetch_at?: LastFetchAt; | ||
created_at?: CreatedAt; | ||
environment?: Environment; | ||
project?: Project; | ||
}[]; | ||
declare namespace DeleteResponse { | ||
interface Model extends BaseModel { | ||
page?: number; | ||
configs?: Configs; | ||
} | ||
} | ||
declare namespace ConfigsCreateRequest { | ||
declare namespace CloneRequest { | ||
interface Model extends BaseModel { | ||
@@ -651,103 +344,2 @@ /** | ||
/** | ||
* Identifier for the environment object. | ||
*/ | ||
environment: string; | ||
/** | ||
* Name of the new branch config. | ||
*/ | ||
name: string; | ||
} | ||
} | ||
declare namespace ConfigsCreate200Response { | ||
interface Model extends BaseModel { | ||
config?: Config; | ||
} | ||
interface Config { | ||
name?: string; | ||
root?: boolean; | ||
locked?: boolean; | ||
initial_fetch_at?: string; | ||
last_fetch_at?: string; | ||
created_at?: string; | ||
environment?: string; | ||
project?: string; | ||
} | ||
} | ||
declare namespace ConfigsGet200Response { | ||
interface Model extends BaseModel { | ||
config?: Config; | ||
} | ||
interface Config { | ||
name?: string; | ||
root?: boolean; | ||
locked?: boolean; | ||
initial_fetch_at?: string; | ||
last_fetch_at?: string; | ||
created_at?: string; | ||
environment?: string; | ||
project?: string; | ||
} | ||
} | ||
declare namespace ConfigsUpdateRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
/** | ||
* Name of the config object. | ||
*/ | ||
config: string; | ||
/** | ||
* The new name of config. | ||
*/ | ||
name: string; | ||
} | ||
} | ||
declare namespace ConfigsUpdate200Response { | ||
interface Model extends BaseModel { | ||
config?: Config; | ||
} | ||
interface Config { | ||
name?: string; | ||
root?: boolean; | ||
locked?: boolean; | ||
initial_fetch_at?: string; | ||
last_fetch_at?: string; | ||
created_at?: string; | ||
environment?: string; | ||
project?: string; | ||
} | ||
} | ||
declare namespace ConfigsDeleteRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
/** | ||
* Name of the config object. | ||
*/ | ||
config: string; | ||
} | ||
} | ||
declare namespace ConfigsDelete200Response { | ||
interface Model extends BaseModel { | ||
success?: boolean; | ||
} | ||
} | ||
declare namespace ConfigsCloneRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
/** | ||
* Name of the branch config being cloned. | ||
@@ -763,3 +355,3 @@ */ | ||
declare namespace ConfigsClone200Response { | ||
declare namespace CloneResponse { | ||
interface Model extends BaseModel { | ||
@@ -780,3 +372,3 @@ config?: Config; | ||
declare namespace ConfigsLockRequest { | ||
declare namespace LockRequest { | ||
interface Model extends BaseModel { | ||
@@ -794,3 +386,3 @@ /** | ||
declare namespace ConfigsLock200Response { | ||
declare namespace LockResponse { | ||
interface Model extends BaseModel { | ||
@@ -811,3 +403,3 @@ config?: Config; | ||
declare namespace ConfigsUnlockRequest { | ||
declare namespace UnlockRequest { | ||
interface Model extends BaseModel { | ||
@@ -825,3 +417,3 @@ /** | ||
declare namespace ConfigsUnlock200Response { | ||
declare namespace UnlockResponse { | ||
interface Model extends BaseModel { | ||
@@ -852,3 +444,3 @@ config?: Config; | ||
* @param optionalParams.perPage - Items per page | ||
* @returns {Promise<ConfigsList200Response.Model>} - The promise with the result | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
@@ -859,3 +451,3 @@ list(project: string, optionalParams?: { | ||
perPage?: number; | ||
}): Promise<ConfigsList200Response.Model>; | ||
}): Promise<ListResponse.Model>; | ||
/** | ||
@@ -865,5 +457,5 @@ * @summary Create | ||
* @returns {Promise<ConfigsCreate200Response.Model>} - The promise with the result | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
create(input: ConfigsCreateRequest.Model): Promise<ConfigsCreate200Response.Model>; | ||
create(input: CreateRequest.Model): Promise<CreateResponse.Model>; | ||
/** | ||
@@ -875,5 +467,5 @@ * @summary Retrieve | ||
* @param config Name of the config object. | ||
* @returns {Promise<ConfigsGet200Response.Model>} - The promise with the result | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(project: string, config: string): Promise<ConfigsGet200Response.Model>; | ||
get(project: string, config: string): Promise<GetResponse.Model>; | ||
/** | ||
@@ -883,5 +475,5 @@ * @summary Update | ||
* @returns {Promise<ConfigsUpdate200Response.Model>} - The promise with the result | ||
* @returns {Promise<UpdateResponse.Model>} - The promise with the result | ||
*/ | ||
update(input: ConfigsUpdateRequest.Model): Promise<ConfigsUpdate200Response.Model>; | ||
update(input: UpdateRequest.Model): Promise<UpdateResponse.Model>; | ||
/** | ||
@@ -891,5 +483,5 @@ * @summary Delete | ||
* @returns {Promise<ConfigsDelete200Response.Model>} - The promise with the result | ||
* @returns {Promise<DeleteResponse.Model>} - The promise with the result | ||
*/ | ||
delete(input: ConfigsDeleteRequest.Model): Promise<ConfigsDelete200Response.Model>; | ||
delete(input: DeleteRequest.Model): Promise<DeleteResponse.Model>; | ||
/** | ||
@@ -899,5 +491,5 @@ * @summary Clone | ||
* @returns {Promise<ConfigsClone200Response.Model>} - The promise with the result | ||
* @returns {Promise<CloneResponse.Model>} - The promise with the result | ||
*/ | ||
clone(input: ConfigsCloneRequest.Model): Promise<ConfigsClone200Response.Model>; | ||
clone(input: CloneRequest.Model): Promise<CloneResponse.Model>; | ||
/** | ||
@@ -907,5 +499,5 @@ * @summary Lock | ||
* @returns {Promise<ConfigsLock200Response.Model>} - The promise with the result | ||
* @returns {Promise<LockResponse.Model>} - The promise with the result | ||
*/ | ||
lock(input: ConfigsLockRequest.Model): Promise<ConfigsLock200Response.Model>; | ||
lock(input: LockRequest.Model): Promise<LockResponse.Model>; | ||
/** | ||
@@ -915,9 +507,153 @@ * @summary Unlock | ||
* @returns {Promise<ConfigsUnlock200Response.Model>} - The promise with the result | ||
* @returns {Promise<UnlockResponse.Model>} - The promise with the result | ||
*/ | ||
unlock(input: ConfigsUnlockRequest.Model): Promise<ConfigsUnlock200Response.Model>; | ||
unlock(input: UnlockRequest.Model): Promise<UnlockResponse.Model>; | ||
} | ||
declare namespace ActivityLogsRetrieve200Response { | ||
declare namespace Format { | ||
type Model = 'json' | 'dotnet-json' | 'env' | 'yaml' | 'docker' | 'env-no-quotes'; | ||
} | ||
declare namespace NameTransformer { | ||
type Model = 'camel' | 'upper-camel' | 'lower-snake' | 'tf-var' | 'dotnet' | 'dotnet-env' | 'lower-kebab'; | ||
} | ||
declare namespace DownloadResponse { | ||
interface Model extends BaseModel { | ||
STRIPE?: string; | ||
ALGOLIA?: string; | ||
DATABASE?: string; | ||
USER?: string; | ||
} | ||
} | ||
declare namespace NamesResponse { | ||
type Names = string[]; | ||
interface Model extends BaseModel { | ||
names?: Names; | ||
} | ||
} | ||
declare namespace UpdateNoteRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
/** | ||
* Name of the config object. | ||
*/ | ||
config: string; | ||
secret: string; | ||
note: string; | ||
} | ||
} | ||
declare namespace UpdateNoteResponse { | ||
interface Model extends BaseModel { | ||
secret?: string; | ||
note?: string; | ||
} | ||
} | ||
declare class SecretsService extends BaseService { | ||
/** | ||
* @summary List | ||
* @description Secrets | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.accepts - Available options are: **application/json**, **text/plain** | ||
* @param optionalParams.includeDynamicSecrets - Whether or not to issue leases and include dynamic secret values for the config | ||
* @param optionalParams.dynamicSecretsTtlSec - The number of seconds until dynamic leases expire. Must be used with `include_dynamic_secrets`. Defaults to 1800 (30 minutes). | ||
* @param optionalParams.secrets - A comma-separated list of secrets to include in the response | ||
* @param optionalParams.includeManagedSecrets - Whether to include Doppler's auto-generated (managed) secrets | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(project: string, config: string, optionalParams?: { | ||
accepts?: string; | ||
includeDynamicSecrets?: boolean; | ||
dynamicSecretsTtlSec?: number; | ||
secrets?: string; | ||
includeManagedSecrets?: boolean; | ||
}): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Update | ||
* @description Secrets | ||
* @returns {Promise<UpdateResponse.Model>} - The promise with the result | ||
*/ | ||
update(input: UpdateRequest.Model): Promise<UpdateResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @description Secret | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param name Name of the secret. | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(project: string, config: string, name: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @description Secret | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param name Name of the secret. | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
delete(project: string, config: string, name: string): Promise<any>; | ||
/** | ||
* @summary Download | ||
* @description Download Secrets | ||
* @param project Unique identifier for the project object. Not required if using a Service Token. | ||
* @param config Name of the config object. Not required if using a Service Token. | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.format - Needed input variable | ||
* @param optionalParams.nameTransformer - Transform secret names to a different case | ||
* @param optionalParams.includeDynamicSecrets - Whether or not to issue leases and include dynamic secret values for the config | ||
* @param optionalParams.dynamicSecretsTtlSec - The number of seconds until dynamic leases expire. Must be used with `include_dynamic_secrets`. Defaults to 1800 (30 minutes). | ||
* @returns {Promise<DownloadResponse.Model>} - The promise with the result | ||
*/ | ||
download(project: string, config: string, optionalParams?: { | ||
format?: Format.Model; | ||
nameTransformer?: NameTransformer.Model; | ||
includeDynamicSecrets?: boolean; | ||
dynamicSecretsTtlSec?: number; | ||
}): Promise<DownloadResponse.Model>; | ||
/** | ||
* @summary List Names | ||
* @description Secret Names | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.includeDynamicSecrets - Whether or not to issue leases and include dynamic secret values for the config | ||
* @param optionalParams.includeManagedSecrets - Whether to include Doppler's auto-generated (managed) secrets | ||
* @returns {Promise<NamesResponse.Model>} - The promise with the result | ||
*/ | ||
names(project: string, config: string, optionalParams?: { | ||
includeDynamicSecrets?: boolean; | ||
includeManagedSecrets?: boolean; | ||
}): Promise<NamesResponse.Model>; | ||
/** | ||
* @summary Update Note | ||
* @description Set a note on a secret | ||
* @returns {Promise<UpdateNoteResponse.Model>} - The promise with the result | ||
*/ | ||
updateNote(input: UpdateNoteRequest.Model): Promise<UpdateNoteResponse.Model>; | ||
} | ||
declare namespace RollbackResponse { | ||
type Name = string; | ||
type Removed = string; | ||
type Diff = { | ||
name?: Name; | ||
removed?: Removed; | ||
}[]; | ||
interface Model extends BaseModel { | ||
log?: Log; | ||
@@ -929,4 +665,6 @@ } | ||
html?: string; | ||
diff?: Diff; | ||
rollback?: boolean; | ||
created_at?: string; | ||
config?: Config; | ||
config?: string; | ||
environment?: string; | ||
@@ -936,8 +674,6 @@ project?: string; | ||
} | ||
interface Config { | ||
[k: string]: unknown; | ||
} | ||
interface User { | ||
email?: string; | ||
name?: string; | ||
username?: string; | ||
profile_image_url?: string; | ||
@@ -947,61 +683,41 @@ } | ||
declare namespace ActivityLogsList200Response { | ||
type Id = string; | ||
type Text = string; | ||
type Html = string; | ||
type CreatedAt = string; | ||
type Environment = string; | ||
type Project = string; | ||
type Email = string; | ||
type Name = string; | ||
type ProfileImageUrl = string; | ||
type Logs = { | ||
id?: Id; | ||
text?: Text; | ||
html?: Html; | ||
created_at?: CreatedAt; | ||
config?: Config; | ||
environment?: Environment; | ||
project?: Project; | ||
user?: User; | ||
}[]; | ||
interface Model extends BaseModel { | ||
declare class ConfigLogsService extends BaseService { | ||
/** | ||
* @summary List | ||
* @description Config Logs | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.page - Page number | ||
* @param optionalParams.perPage - Items per page | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(project: string, config: string, optionalParams?: { | ||
page?: number; | ||
logs?: Logs; | ||
} | ||
interface Config { | ||
[k: string]: unknown; | ||
} | ||
interface User { | ||
email?: Email; | ||
name?: Name; | ||
profile_image_url?: ProfileImageUrl; | ||
} | ||
} | ||
declare class ActivityLogsService extends BaseService { | ||
perPage?: number; | ||
}): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @description Activity Log | ||
* @description Config Log | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param log Unique identifier for the log object. | ||
* @returns {Promise<ActivityLogsRetrieve200Response.Model>} - The promise with the result | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
retrieve(log: string): Promise<ActivityLogsRetrieve200Response.Model>; | ||
get(project: string, config: string, log: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary List | ||
* @description Activity Logs | ||
* @summary Rollback | ||
* @description Config Log | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.page - Page number | ||
* @param optionalParams.perPage - Items per page | ||
* @returns {Promise<ActivityLogsList200Response.Model>} - The promise with the result | ||
* @param project Unique identifier for the project object. | ||
* @param config Name of the config object. | ||
* @param log Unique identifier for the log object. | ||
* @returns {Promise<RollbackResponse.Model>} - The promise with the result | ||
*/ | ||
list(optionalParams?: { | ||
page?: string; | ||
perPage?: number; | ||
}): Promise<ActivityLogsList200Response.Model>; | ||
rollback(project: string, config: string, log: string): Promise<RollbackResponse.Model>; | ||
} | ||
declare namespace V3Me200Response { | ||
declare namespace MeResponse { | ||
interface Model extends BaseModel { | ||
@@ -1027,58 +743,53 @@ slug?: string; | ||
* @returns {Promise<V3Me200Response.Model>} - The promise with the result | ||
* @returns {Promise<MeResponse.Model>} - The promise with the result | ||
*/ | ||
me(): Promise<V3Me200Response.Model>; | ||
me(): Promise<MeResponse.Model>; | ||
} | ||
declare namespace ServiceTokensCreateRequest { | ||
/** | ||
* Token's capabilities. | ||
*/ | ||
type Access = 'read' | 'read/write'; | ||
declare namespace RetrieveResponse { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
/** | ||
* Name of the config object. | ||
*/ | ||
config: string; | ||
/** | ||
* Name of the service token. | ||
*/ | ||
name: string; | ||
/** | ||
* Unix timestamp of when token should expire. | ||
*/ | ||
expire_at?: string; | ||
access?: Access; | ||
log?: Log; | ||
} | ||
} | ||
declare namespace ServiceTokensDeleteRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* Unique identifier for the project object. | ||
*/ | ||
project: string; | ||
/** | ||
* Name of the config object. | ||
*/ | ||
config: string; | ||
/** | ||
* The slug of the service token. | ||
*/ | ||
slug?: string; | ||
/** | ||
* The token value. | ||
*/ | ||
token?: string; | ||
interface Log { | ||
id?: string; | ||
text?: string; | ||
html?: string; | ||
created_at?: string; | ||
config?: Config; | ||
environment?: string; | ||
project?: string; | ||
user?: User; | ||
} | ||
interface Config { | ||
[k: string]: unknown; | ||
} | ||
interface User { | ||
email?: string; | ||
name?: string; | ||
profile_image_url?: string; | ||
} | ||
} | ||
declare namespace ServiceTokensDelete200Response { | ||
interface Model extends BaseModel { | ||
success?: boolean; | ||
} | ||
declare class ActivityLogsService extends BaseService { | ||
/** | ||
* @summary List | ||
* @description Activity Logs | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.page - Page number | ||
* @param optionalParams.perPage - Items per page | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(optionalParams?: { | ||
page?: string; | ||
perPage?: number; | ||
}): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @description Activity Log | ||
* @param log Unique identifier for the log object. | ||
* @returns {Promise<RetrieveResponse.Model>} - The promise with the result | ||
*/ | ||
retrieve(log: string): Promise<RetrieveResponse.Model>; | ||
} | ||
@@ -1093,5 +804,5 @@ | ||
* @param config Name of the config object. | ||
* @returns {Promise<any>} - The promise with the result | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(project: string, config: string): Promise<any>; | ||
list(project: string, config: string): Promise<ListResponse.Model>; | ||
/** | ||
@@ -1101,5 +812,5 @@ * @summary Create | ||
* @returns {Promise<any>} - The promise with the result | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
create(input: ServiceTokensCreateRequest.Model): Promise<any>; | ||
create(input: CreateRequest.Model): Promise<CreateResponse.Model>; | ||
/** | ||
@@ -1109,8 +820,8 @@ * @summary Delete | ||
* @returns {Promise<ServiceTokensDelete200Response.Model>} - The promise with the result | ||
* @returns {Promise<DeleteResponse.Model>} - The promise with the result | ||
*/ | ||
delete(input: ServiceTokensDeleteRequest.Model): Promise<ServiceTokensDelete200Response.Model>; | ||
delete(input: DeleteRequest.Model): Promise<DeleteResponse.Model>; | ||
} | ||
declare namespace DynamicSecretsIssueLeaseRequest { | ||
declare namespace IssueLeaseRequest { | ||
interface Model extends BaseModel { | ||
@@ -1136,4 +847,15 @@ /** | ||
declare namespace DynamicSecretsRevokeLeaseRequest { | ||
declare namespace IssueLeaseResponse { | ||
interface Model extends BaseModel { | ||
success?: boolean; | ||
id?: string; | ||
expires_at?: string; | ||
value?: Value; | ||
} | ||
interface Value { | ||
} | ||
} | ||
declare namespace RevokeLeaseRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
@@ -1158,3 +880,3 @@ * The project where the dynamic secret is located | ||
declare namespace DynamicSecretsRevokeLease200Response { | ||
declare namespace RevokeLeaseResponse { | ||
interface Model extends BaseModel { | ||
@@ -1170,172 +892,420 @@ success?: boolean; | ||
* @returns {Promise<any>} - The promise with the result | ||
* @returns {Promise<IssueLeaseResponse.Model>} - The promise with the result | ||
*/ | ||
issueLease(input: DynamicSecretsIssueLeaseRequest.Model): Promise<any>; | ||
issueLease(input: IssueLeaseRequest.Model): Promise<IssueLeaseResponse.Model>; | ||
/** | ||
* @summary Revoke Lease | ||
* @returns {Promise<DynamicSecretsRevokeLease200Response.Model>} - The promise with the result | ||
* @returns {Promise<RevokeLeaseResponse.Model>} - The promise with the result | ||
*/ | ||
revokeLease(input: DynamicSecretsRevokeLeaseRequest.Model): Promise<DynamicSecretsRevokeLease200Response.Model>; | ||
revokeLease(input: RevokeLeaseRequest.Model): Promise<RevokeLeaseResponse.Model>; | ||
} | ||
declare namespace IntegrationsCreateRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* The name of the integration | ||
*/ | ||
name: string; | ||
data?: Data; | ||
/** | ||
* The integration type | ||
*/ | ||
type_: string; | ||
} | ||
declare class IntegrationsService extends BaseService { | ||
/** | ||
* The authentication data for the integration | ||
* @summary List | ||
* @description List all existing integrations | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
interface Data { | ||
} | ||
list(): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Create | ||
* @description Create a new external integration. | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
create(input: CreateRequest.Model): Promise<CreateResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @description Retrieve an existing integration | ||
* @param integration The integration slug | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(integration: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary Update | ||
* @description Update an existing integration. | ||
* @param integration The slug of the integration to update | ||
* @returns {Promise<UpdateResponse.Model>} - The promise with the result | ||
*/ | ||
update(input: UpdateRequest.Model, integration: string): Promise<UpdateResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @description Delete an existing integration. | ||
* @param integration The slug of the integration to delete | ||
* @returns {Promise<DeleteResponse.Model>} - The promise with the result | ||
*/ | ||
delete(integration: string): Promise<DeleteResponse.Model>; | ||
} | ||
declare namespace IntegrationsCreate200Response { | ||
interface Model extends BaseModel { | ||
} | ||
declare class SyncsService extends BaseService { | ||
/** | ||
* @summary Create | ||
* @description Create a new secrets sync. | ||
* @param project The project slug | ||
* @param config The config slug | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
create(input: CreateRequest.Model, project: string, config: string): Promise<CreateResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @description Retrieve an existing secrets sync. | ||
* @param project The project slug | ||
* @param config The config slug | ||
* @param sync The sync slug | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(project: string, config: string, sync: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @description Delete an existing sync. | ||
* @param project The project slug | ||
* @param config The config slug | ||
* @param sync The sync slug | ||
* @param deleteFromTarget Whether or not to delete the synced data from the target integration | ||
* @returns {Promise<DeleteResponse.Model>} - The promise with the result | ||
*/ | ||
delete(project: string, config: string, sync: string, deleteFromTarget: boolean): Promise<DeleteResponse.Model>; | ||
} | ||
declare namespace IntegrationsGet200Response { | ||
declare namespace AddRequest { | ||
/** | ||
* Environment slugs to grant the member access to | ||
*/ | ||
type Environments = string[]; | ||
type Type = 'workplace_user' | 'group' | 'invite' | 'service_account'; | ||
interface Model extends BaseModel { | ||
} | ||
} | ||
declare namespace IntegrationsUpdateRequest { | ||
interface Model extends BaseModel { | ||
/** | ||
* The new name of the integration | ||
* Member's slug | ||
*/ | ||
name?: string; | ||
slug: string; | ||
/** | ||
* The new authentication data for the integration | ||
* Identifier of the project role | ||
*/ | ||
data?: string; | ||
role?: string; | ||
environments?: Environments; | ||
type_: Type; | ||
} | ||
} | ||
declare namespace IntegrationsUpdate200Response { | ||
declare namespace AddResponse { | ||
type Environments = string[]; | ||
interface Model extends BaseModel { | ||
member?: Member; | ||
} | ||
interface Member { | ||
slug?: string; | ||
role?: Role; | ||
access_all_environments?: boolean; | ||
environments?: Environments; | ||
type_?: string; | ||
} | ||
interface Role { | ||
identifier?: string; | ||
} | ||
} | ||
declare namespace IntegrationsDelete200Response { | ||
declare class TrustedIpsService extends BaseService { | ||
/** | ||
* @summary List | ||
* @param project Needed input variable | ||
* @param config Needed input variable | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(project: string, config: string): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Add | ||
* @param project Needed input variable | ||
* @param config Needed input variable | ||
* @returns {Promise<AddResponse.Model>} - The promise with the result | ||
*/ | ||
add(input: AddRequest.Model, project: string, config: string): Promise<AddResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @param project Needed input variable | ||
* @param config Needed input variable | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
delete(input: DeleteRequest.Model, project: string, config: string): Promise<any>; | ||
} | ||
declare namespace ListPermissionsResponse { | ||
type Permissions = string[]; | ||
interface Model extends BaseModel { | ||
permissions?: Permissions; | ||
} | ||
} | ||
declare class IntegrationsService extends BaseService { | ||
declare class WorkplaceRolesService extends BaseService { | ||
/** | ||
* @summary List | ||
* @description List all existing integrations | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Create | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
create(): Promise<CreateResponse.Model>; | ||
/** | ||
* @summary List Permissions | ||
* @returns {Promise<ListPermissionsResponse.Model>} - The promise with the result | ||
*/ | ||
listPermissions(): Promise<ListPermissionsResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @param role The role's unique identifier | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(role: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary Update | ||
* @param role The role's unique identifier | ||
* @returns {Promise<UpdateResponse.Model>} - The promise with the result | ||
*/ | ||
update(role: string): Promise<UpdateResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @param role The role's unique identifier | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
list(): Promise<any>; | ||
delete(role: string): Promise<any>; | ||
} | ||
declare class ProjectRolesService extends BaseService { | ||
/** | ||
* @summary List | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Create | ||
* @description Create a new external integration. | ||
* @returns {Promise<IntegrationsCreate200Response.Model>} - The promise with the result | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
create(input: IntegrationsCreateRequest.Model): Promise<IntegrationsCreate200Response.Model>; | ||
create(): Promise<CreateResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @description Retrieve an existing integration | ||
* @param integration The integration slug | ||
* @returns {Promise<IntegrationsGet200Response.Model>} - The promise with the result | ||
* @param role The role's unique identifier | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(integration: string): Promise<IntegrationsGet200Response.Model>; | ||
get(role: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary Update | ||
* @description Update an existing integration. | ||
* @param integration The slug of the integration to update | ||
* @returns {Promise<IntegrationsUpdate200Response.Model>} - The promise with the result | ||
* @param role The role's unique identifier | ||
* @returns {Promise<UpdateResponse.Model>} - The promise with the result | ||
*/ | ||
update(input: IntegrationsUpdateRequest.Model, integration: string): Promise<IntegrationsUpdate200Response.Model>; | ||
update(role: string): Promise<UpdateResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @description Delete an existing integration. | ||
* @param integration The slug of the integration to delete | ||
* @returns {Promise<IntegrationsDelete200Response.Model>} - The promise with the result | ||
* @param role The role's unique identifier | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
delete(integration: string): Promise<IntegrationsDelete200Response.Model>; | ||
delete(role: string): Promise<any>; | ||
/** | ||
* @summary List Permissions | ||
* @returns {Promise<ListPermissionsResponse.Model>} - The promise with the result | ||
*/ | ||
listPermissions(): Promise<ListPermissionsResponse.Model>; | ||
} | ||
declare namespace SyncsCreateRequest { | ||
declare namespace Type { | ||
type Model = 'workplace_user'; | ||
} | ||
declare class ProjectMembersService extends BaseService { | ||
/** | ||
* An option indicating if and how Doppler should attempt to import secrets from the sync destination | ||
* @summary List | ||
* @param project Project slug | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.page - Needed input variable | ||
* @param optionalParams.perPage - Needed input variable | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
type ImportOption = 'none' | 'prefer_doppler' | 'prefer_integration'; | ||
interface Model extends BaseModel { | ||
/** | ||
* The integration slug which the sync will use | ||
*/ | ||
integration: string; | ||
data: Data; | ||
import_option?: ImportOption; | ||
} | ||
list(project: string, optionalParams?: { | ||
page?: number; | ||
perPage?: number; | ||
}): Promise<ListResponse.Model>; | ||
/** | ||
* Configuration data for the sync | ||
* @summary Add | ||
* @param project Project slug | ||
* @returns {Promise<AddResponse.Model>} - The promise with the result | ||
*/ | ||
interface Data { | ||
} | ||
add(input: AddRequest.Model, project: string): Promise<AddResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @param project Project slug | ||
* @param type_ Needed input variable | ||
* @param slug Member's slug | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(project: string, type: Type.Model, slug: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary Update | ||
* @param type_ Needed input variable | ||
* @param slug Member's slug | ||
* @param project Project slug | ||
* @returns {Promise<UpdateResponse.Model>} - The promise with the result | ||
*/ | ||
update(input: UpdateRequest.Model, type: Type.Model, slug: string, project: string): Promise<UpdateResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @param type_ Needed input variable | ||
* @param slug Member's slug | ||
* @param project Project slug | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
delete(type: Type.Model, slug: string, project: string): Promise<any>; | ||
} | ||
declare namespace SyncsCreate200Response { | ||
interface Model extends BaseModel { | ||
} | ||
declare class InvitesService extends BaseService { | ||
/** | ||
* @summary List | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.page - Needed input variable | ||
* @param optionalParams.perPage - Needed input variable | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(optionalParams?: { | ||
page?: number; | ||
perPage?: number; | ||
}): Promise<ListResponse.Model>; | ||
} | ||
declare namespace SyncsGet200Response { | ||
interface Model extends BaseModel { | ||
} | ||
declare class ServiceAccountsService extends BaseService { | ||
/** | ||
* @summary List | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.page - Needed input variable | ||
* @param optionalParams.perPage - Needed input variable | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(optionalParams?: { | ||
page?: number; | ||
perPage?: number; | ||
}): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Create | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
create(input: CreateRequest.Model): Promise<CreateResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @param slug Slug of the service account | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(slug: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary Update | ||
* @param slug Slug of the service account | ||
* @returns {Promise<UpdateResponse.Model>} - The promise with the result | ||
*/ | ||
update(input: UpdateRequest.Model, slug: string): Promise<UpdateResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @param slug Slug of the service account | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
delete(slug: string): Promise<any>; | ||
} | ||
declare namespace SyncsDelete200Response { | ||
declare namespace AddMemberRequest { | ||
type Type = 'workplace_user'; | ||
interface Model extends BaseModel { | ||
/** | ||
* The member's slug | ||
*/ | ||
slug: string; | ||
type_: Type; | ||
} | ||
} | ||
declare class SyncsService extends BaseService { | ||
declare class GroupsService extends BaseService { | ||
/** | ||
* @summary List | ||
* @param optionalParams - Optional parameters | ||
* @param optionalParams.page - Needed input variable | ||
* @param optionalParams.perPage - Needed input variable | ||
* @returns {Promise<ListResponse.Model>} - The promise with the result | ||
*/ | ||
list(optionalParams?: { | ||
page?: number; | ||
perPage?: number; | ||
}): Promise<ListResponse.Model>; | ||
/** | ||
* @summary Create | ||
* @description Create a new secrets sync. | ||
* @param project The project slug | ||
* @param config The config slug | ||
* @returns {Promise<SyncsCreate200Response.Model>} - The promise with the result | ||
* @returns {Promise<CreateResponse.Model>} - The promise with the result | ||
*/ | ||
create(input: SyncsCreateRequest.Model, project: string, config: string): Promise<SyncsCreate200Response.Model>; | ||
create(input: CreateRequest.Model): Promise<CreateResponse.Model>; | ||
/** | ||
* @summary Retrieve | ||
* @description Retrieve an existing secrets sync. | ||
* @param project The project slug | ||
* @param config The config slug | ||
* @param sync The sync slug | ||
* @returns {Promise<SyncsGet200Response.Model>} - The promise with the result | ||
* @param slug The group's slug | ||
* @returns {Promise<GetResponse.Model>} - The promise with the result | ||
*/ | ||
get(project: string, config: string, sync: string): Promise<SyncsGet200Response.Model>; | ||
get(slug: string): Promise<GetResponse.Model>; | ||
/** | ||
* @summary Update | ||
* @param slug The group's slug | ||
* @returns {Promise<UpdateResponse.Model>} - The promise with the result | ||
*/ | ||
update(input: UpdateRequest.Model, slug: string): Promise<UpdateResponse.Model>; | ||
/** | ||
* @summary Delete | ||
* @description Delete an existing sync. | ||
* @param project The project slug | ||
* @param config The config slug | ||
* @param sync The sync slug | ||
* @param deleteFromTarget Whether or not to delete the synced data from the target integration | ||
* @returns {Promise<SyncsDelete200Response.Model>} - The promise with the result | ||
* @param slug The group's slug | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
delete(project: string, config: string, sync: string, deleteFromTarget: boolean): Promise<SyncsDelete200Response.Model>; | ||
delete(slug: string): Promise<any>; | ||
/** | ||
* @summary Add Member | ||
* @param slug The group's slug | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
addMember(input: AddMemberRequest.Model, slug: string): Promise<any>; | ||
/** | ||
* @summary Delete Member | ||
* @param slug The group's slug | ||
* @param type_ Needed input variable | ||
* @param memberSlug The member's slug | ||
* @returns {Promise<any>} - The promise with the result | ||
*/ | ||
deleteMember(slug: string, type: Type.Model, memberSlug: string): Promise<any>; | ||
} | ||
@@ -1345,8 +1315,8 @@ | ||
projects: ProjectsService; | ||
environments: EnvironmentsService; | ||
configs: ConfigsService; | ||
secrets: SecretsService; | ||
configLogs: ConfigLogsService; | ||
environments: EnvironmentsService; | ||
configs: ConfigsService; | ||
v3: V3Service; | ||
activityLogs: ActivityLogsService; | ||
v3: V3Service; | ||
serviceTokens: ServiceTokensService; | ||
@@ -1356,6 +1326,13 @@ dynamicSecrets: DynamicSecretsService; | ||
syncs: SyncsService; | ||
constructor(bearerToken?: string); | ||
setBearerToken(bearerToken: string): void; | ||
trustedIps: TrustedIpsService; | ||
workplaceRoles: WorkplaceRolesService; | ||
projectRoles: ProjectRolesService; | ||
projectMembers: ProjectMembersService; | ||
invites: InvitesService; | ||
serviceAccounts: ServiceAccountsService; | ||
groups: GroupsService; | ||
constructor(accessToken?: string); | ||
setAccessToken(accessToken: string): void; | ||
} | ||
export { ActivityLogsList200Response, ActivityLogsRetrieve200Response, ConfigLogsGet200Response, ConfigLogsList200Response, ConfigLogsRollback200Response, ConfigsClone200Response, ConfigsCloneRequest, ConfigsCreate200Response, ConfigsCreateRequest, ConfigsDelete200Response, ConfigsDeleteRequest, ConfigsGet200Response, ConfigsList200Response, ConfigsLock200Response, ConfigsLockRequest, ConfigsUnlock200Response, ConfigsUnlockRequest, ConfigsUpdate200Response, ConfigsUpdateRequest, DopplerSDK, DynamicSecretsIssueLeaseRequest, DynamicSecretsRevokeLease200Response, DynamicSecretsRevokeLeaseRequest, EnvironmentsCreate200Response, EnvironmentsCreateRequest, EnvironmentsGet200Response, EnvironmentsList200Response, EnvironmentsRename200Response, EnvironmentsRenameRequest, IntegrationsCreate200Response, IntegrationsCreateRequest, IntegrationsDelete200Response, IntegrationsGet200Response, IntegrationsUpdate200Response, IntegrationsUpdateRequest, ProjectsCreate200Response, ProjectsCreateRequest, ProjectsDeleteRequest, ProjectsGet200Response, ProjectsList200Response, ProjectsUpdate200Response, ProjectsUpdateRequest, SecretsDownload200Response, SecretsGet200Response, SecretsListNames200Response, SecretsUpdate200Response, SecretsUpdateNote200Response, SecretsUpdateNoteRequest, SecretsUpdateRequest, ServiceTokensCreateRequest, ServiceTokensDelete200Response, ServiceTokensDeleteRequest, SyncsCreate200Response, SyncsCreateRequest, SyncsDelete200Response, SyncsGet200Response, V3Me200Response, DopplerSDK as default }; | ||
export { AddMemberRequest, AddRequest, AddResponse, CloneRequest, CloneResponse, CreateRequest, CreateResponse, DeleteRequest, DeleteResponse, DopplerSDK, DownloadResponse, Format, GetResponse, IssueLeaseRequest, IssueLeaseResponse, ListPermissionsResponse, ListResponse, LockRequest, LockResponse, MeResponse, NameTransformer, NamesResponse, RenameRequest, RenameResponse, RetrieveResponse, RevokeLeaseRequest, RevokeLeaseResponse, RollbackResponse, Type, UnlockRequest, UnlockResponse, UpdateNoteRequest, UpdateNoteResponse, UpdateRequest, UpdateResponse, DopplerSDK as default }; |
@@ -17,3 +17,2 @@ { | ||
"dist", | ||
"src", | ||
"README.md" | ||
@@ -51,7 +50,8 @@ ], | ||
"watch": "rm -rf dist/ && tsc -w", | ||
"version": "tsc --version" | ||
"version": "tsc --version", | ||
"prepublishOnly": "npm run build" | ||
}, | ||
"name": "@dopplerhq/node-sdk", | ||
"description": "DopplerSDK", | ||
"version": "1.0.2", | ||
"version": "1.1.0", | ||
"author": "DopplerSDK", | ||
@@ -58,0 +58,0 @@ "dependencies": {}, |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
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
231825
5
7137