From 7243ddf604733ca53db473d2a24deac8e5690464 Mon Sep 17 00:00:00 2001 From: Lajos Szoke Date: Mon, 9 Sep 2024 09:36:00 +0200 Subject: [PATCH 1/2] Regenerate based on live api --- .openapi-generator/FILES | 25 +- api.ts | 4 +- api/audit-logs-api.ts | 2 +- api/code-references-api.ts | 77 +-- api/configs-api.ts | 2 +- api/environments-api.ts | 2 +- api/feature-flag-setting-values-api.ts | 34 +- ...re-flag-setting-values-using-sdkkey-api.ts | 18 +- ...flag-setting-values-using-sdkkey-v2-api.ts | 18 +- api/feature-flag-setting-values-v2-api.ts | 34 +- api/feature-flags-settings-api.ts | 94 ++- api/integration-links-api.ts | 2 +- api/integrations-api.ts | 451 +++++++++++++ api/me-api.ts | 2 +- api/members-api.ts | 263 +++++++- api/organizations-api.ts | 2 +- api/permission-groups-api.ts | 2 +- api/products-api.ts | 161 ++++- api/sdkkeys-api.ts | 2 +- api/segments-api.ts | 2 +- api/tags-api.ts | 2 +- api/webhooks-api.ts | 613 ++++++++++++++++++ base.ts | 4 +- common.ts | 2 +- configuration.ts | 2 +- index.ts | 2 +- model/access-type.ts | 2 +- model/add-or-update-integration-link-model.ts | 2 +- ...d-or-update-jira-integration-link-model.ts | 2 +- model/audit-log-item-model.ts | 2 +- model/audit-log-type.ts | 2 +- model/code-reference-model.ts | 2 +- model/code-reference-request.ts | 2 +- model/comparison-value-list-model.ts | 2 +- model/comparison-value-model.ts | 2 +- model/condition-model.ts | 2 +- model/config-model.ts | 2 +- model/config-setting-formula-model.ts | 2 +- model/config-setting-formulas-model.ts | 2 +- model/config-setting-value-model.ts | 2 +- model/config-setting-values-model.ts | 2 +- model/connect-request.ts | 2 +- model/create-config-request.ts | 2 +- model/create-environment-model.ts | 2 +- model/create-integration-model.ts | 59 ++ ...eate-or-update-environment-access-model.ts | 2 +- model/create-permission-group-request.ts | 2 +- model/create-product-request.ts | 2 +- model/create-segment-model.ts | 2 +- model/create-setting-initial-values.ts | 2 +- model/create-tag-model.ts | 2 +- model/delete-integration-link-model.ts | 2 +- model/delete-repository-reports-request.ts | 2 +- model/environment-access-model.ts | 2 +- model/environment-access-type.ts | 2 +- model/environment-model.ts | 2 +- model/evaluation-version.ts | 2 +- model/feature-flag-limitations.ts | 2 +- model/flag-reference.ts | 2 +- model/index.ts | 23 +- model/initial-value.ts | 2 +- model/integration-link-detail.ts | 2 +- model/integration-link-details-model.ts | 2 +- model/integration-link-model.ts | 2 +- model/integration-link-type.ts | 2 +- model/integration-model.ts | 74 +++ model/integration-type.ts | 35 + model/integrations-model.ts | 33 + model/invitation-model.ts | 54 ++ model/invite-members-request.ts | 2 +- model/json-patch-operation.ts | 2 +- model/key-generation-mode.ts | 34 + model/me-model.ts | 2 +- model/member-model.ts | 2 +- model/modify-integration-request.ts | 48 ++ model/operation-type.ts | 2 +- model/organization-admin-model.ts | 2 +- model/organization-invitation-model.ts | 72 ++ model/organization-member-model.ts | 2 +- model/organization-members-model.ts | 8 +- model/organization-model.ts | 2 +- model/organization-permission-group-model.ts | 2 +- model/organization-permission-model.ts | 2 +- model/organization-product-model.ts | 2 +- model/percentage-option-model.ts | 2 +- model/permission-group-model.ts | 2 +- model/preferences-model.ts | 62 ++ model/prerequisite-comparator.ts | 2 +- model/prerequisite-flag-condition-model.ts | 2 +- model/product-model.ts | 2 +- model/reason-required-environment-model.ts | 42 ++ model/reference-line.ts | 2 +- model/reference-lines.ts | 2 +- model/replace-setting-model.ts | 48 ++ model/rollout-percentage-item-model.ts | 2 +- model/rollout-rule-comparator.ts | 2 +- model/rollout-rule-model.ts | 2 +- model/sdk-keys-model.ts | 2 +- model/segment-comparator.ts | 2 +- model/segment-condition-model.ts | 2 +- model/segment-list-model.ts | 2 +- model/segment-model.ts | 2 +- model/setting-data-model.ts | 2 +- model/setting-formula-model.ts | 2 +- model/setting-model.ts | 2 +- model/setting-tag-model.ts | 2 +- model/setting-type.ts | 2 +- model/setting-value-model.ts | 2 +- model/tag-model.ts | 2 +- model/targeting-rule-model.ts | 2 +- model/update-config-request.ts | 2 +- model/update-environment-model.ts | 2 +- model/update-evaluation-formula-model.ts | 2 +- ...update-evaluation-formula-with-id-model.ts | 2 +- model/update-evaluation-formulas-model.ts | 2 +- model/update-member-permissions-request.ts | 48 ++ model/update-permission-group-request.ts | 2 +- model/update-preferences-request.ts | 62 ++ model/update-product-request.ts | 2 +- ...pdate-reason-required-environment-model.ts | 36 + model/update-segment-model.ts | 2 +- model/update-setting-value-model.ts | 2 +- ...ate-setting-value-with-setting-id-model.ts | 2 +- model/update-setting-values-with-id-model.ts | 2 +- model/update-tag-model.ts | 2 +- model/user-comparator.ts | 2 +- model/user-condition-model.ts | 2 +- model/user-model.ts | 2 +- model/value-model.ts | 2 +- model/web-hook-http-method.ts | 31 + model/web-hook-request.ts | 56 ++ model/webhook-config.ts | 36 + model/webhook-environment.ts | 36 + model/webhook-header-model.ts | 42 ++ model/webhook-model.ts | 80 +++ model/webhook-signing-keys-model.ts | 36 + regenerate.md | 4 +- 137 files changed, 2791 insertions(+), 264 deletions(-) create mode 100644 api/integrations-api.ts create mode 100644 api/webhooks-api.ts create mode 100644 model/create-integration-model.ts create mode 100644 model/integration-model.ts create mode 100644 model/integration-type.ts create mode 100644 model/integrations-model.ts create mode 100644 model/invitation-model.ts create mode 100644 model/key-generation-mode.ts create mode 100644 model/modify-integration-request.ts create mode 100644 model/organization-invitation-model.ts create mode 100644 model/preferences-model.ts create mode 100644 model/reason-required-environment-model.ts create mode 100644 model/replace-setting-model.ts create mode 100644 model/update-member-permissions-request.ts create mode 100644 model/update-preferences-request.ts create mode 100644 model/update-reason-required-environment-model.ts create mode 100644 model/web-hook-http-method.ts create mode 100644 model/web-hook-request.ts create mode 100644 model/webhook-config.ts create mode 100644 model/webhook-environment.ts create mode 100644 model/webhook-header-model.ts create mode 100644 model/webhook-model.ts create mode 100644 model/webhook-signing-keys-model.ts diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index e5a949c..e9539da 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -11,6 +11,7 @@ api/feature-flag-setting-values-using-sdkkey-v2-api.ts api/feature-flag-setting-values-v2-api.ts api/feature-flags-settings-api.ts api/integration-links-api.ts +api/integrations-api.ts api/me-api.ts api/members-api.ts api/organizations-api.ts @@ -19,6 +20,7 @@ api/products-api.ts api/sdkkeys-api.ts api/segments-api.ts api/tags-api.ts +api/webhooks-api.ts base.ts common.ts configuration.ts @@ -27,12 +29,10 @@ index.ts model/access-type.ts model/add-or-update-integration-link-model.ts model/add-or-update-jira-integration-link-model.ts -model/add-user-to-group-request.ts model/audit-log-item-model.ts model/audit-log-type.ts model/code-reference-model.ts model/code-reference-request.ts -model/code-references-for-setting-model.ts model/comparison-value-list-model.ts model/comparison-value-model.ts model/condition-model.ts @@ -44,6 +44,7 @@ model/config-setting-values-model.ts model/connect-request.ts model/create-config-request.ts model/create-environment-model.ts +model/create-integration-model.ts model/create-or-update-environment-access-model.ts model/create-permission-group-request.ts model/create-product-request.ts @@ -64,12 +65,19 @@ model/integration-link-detail.ts model/integration-link-details-model.ts model/integration-link-model.ts model/integration-link-type.ts +model/integration-model.ts +model/integration-type.ts +model/integrations-model.ts +model/invitation-model.ts model/invite-members-request.ts model/json-patch-operation.ts +model/key-generation-mode.ts model/me-model.ts model/member-model.ts +model/modify-integration-request.ts model/operation-type.ts model/organization-admin-model.ts +model/organization-invitation-model.ts model/organization-member-model.ts model/organization-members-model.ts model/organization-model.ts @@ -78,11 +86,14 @@ model/organization-permission-model.ts model/organization-product-model.ts model/percentage-option-model.ts model/permission-group-model.ts +model/preferences-model.ts model/prerequisite-comparator.ts model/prerequisite-flag-condition-model.ts model/product-model.ts +model/reason-required-environment-model.ts model/reference-line.ts model/reference-lines.ts +model/replace-setting-model.ts model/rollout-percentage-item-model.ts model/rollout-rule-comparator.ts model/rollout-rule-model.ts @@ -104,8 +115,11 @@ model/update-environment-model.ts model/update-evaluation-formula-model.ts model/update-evaluation-formula-with-id-model.ts model/update-evaluation-formulas-model.ts +model/update-member-permissions-request.ts model/update-permission-group-request.ts +model/update-preferences-request.ts model/update-product-request.ts +model/update-reason-required-environment-model.ts model/update-segment-model.ts model/update-setting-value-model.ts model/update-setting-value-with-setting-id-model.ts @@ -115,3 +129,10 @@ model/user-comparator.ts model/user-condition-model.ts model/user-model.ts model/value-model.ts +model/web-hook-http-method.ts +model/web-hook-request.ts +model/webhook-config.ts +model/webhook-environment.ts +model/webhook-header-model.ts +model/webhook-model.ts +model/webhook-signing-keys-model.ts diff --git a/api.ts b/api.ts index ee4a992..6056ccf 100644 --- a/api.ts +++ b/api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -24,6 +24,7 @@ export * from './api/feature-flag-setting-values-using-sdkkey-v2-api'; export * from './api/feature-flag-setting-values-v2-api'; export * from './api/feature-flags-settings-api'; export * from './api/integration-links-api'; +export * from './api/integrations-api'; export * from './api/me-api'; export * from './api/members-api'; export * from './api/organizations-api'; @@ -32,4 +33,5 @@ export * from './api/products-api'; export * from './api/sdkkeys-api'; export * from './api/segments-api'; export * from './api/tags-api'; +export * from './api/webhooks-api'; diff --git a/api/audit-logs-api.ts b/api/audit-logs-api.ts index cdf8f67..d417d4a 100644 --- a/api/audit-logs-api.ts +++ b/api/audit-logs-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/code-references-api.ts b/api/code-references-api.ts index 22dc28f..a37e6af 100644 --- a/api/code-references-api.ts +++ b/api/code-references-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -26,8 +26,6 @@ import { CodeReferenceModel } from '../model'; // @ts-ignore import { CodeReferenceRequest } from '../model'; // @ts-ignore -import { CodeReferencesForSettingModel } from '../model'; -// @ts-ignore import { DeleteRepositoryReportsRequest } from '../model'; /** * CodeReferencesApi - axios parameter creator @@ -115,44 +113,6 @@ export const CodeReferencesApiAxiosParamCreator = function (configuration?: Conf options: localVarRequestOptions, }; }, - /** - * - * @summary Get References in Config - * @param {string} configId The identifier of the Config. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - v1ConfigsConfigIdCodeReferencesGet: async (configId: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'configId' is not null or undefined - assertParamExists('v1ConfigsConfigIdCodeReferencesGet', 'configId', configId) - const localVarPath = `/v1/configs/{configId}/code-references` - .replace(`{${"configId"}}`, encodeURIComponent(String(configId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication Basic required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * * @summary Get References for Feature Flag or Setting @@ -227,19 +187,6 @@ export const CodeReferencesApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['CodeReferencesApi.v1CodeReferencesPost']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, - /** - * - * @summary Get References in Config - * @param {string} configId The identifier of the Config. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async v1ConfigsConfigIdCodeReferencesGet(configId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.v1ConfigsConfigIdCodeReferencesGet(configId, options); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CodeReferencesApi.v1ConfigsConfigIdCodeReferencesGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, /** * * @summary Get References for Feature Flag or Setting @@ -283,16 +230,6 @@ export const CodeReferencesApiFactory = function (configuration?: Configuration, v1CodeReferencesPost(codeReferenceRequest: CodeReferenceRequest, options?: any): AxiosPromise { return localVarFp.v1CodeReferencesPost(codeReferenceRequest, options).then((request) => request(axios, basePath)); }, - /** - * - * @summary Get References in Config - * @param {string} configId The identifier of the Config. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - v1ConfigsConfigIdCodeReferencesGet(configId: string, options?: any): AxiosPromise> { - return localVarFp.v1ConfigsConfigIdCodeReferencesGet(configId, options).then((request) => request(axios, basePath)); - }, /** * * @summary Get References for Feature Flag or Setting @@ -337,18 +274,6 @@ export class CodeReferencesApi extends BaseAPI { return CodeReferencesApiFp(this.configuration).v1CodeReferencesPost(codeReferenceRequest, options).then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary Get References in Config - * @param {string} configId The identifier of the Config. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CodeReferencesApi - */ - public v1ConfigsConfigIdCodeReferencesGet(configId: string, options?: RawAxiosRequestConfig) { - return CodeReferencesApiFp(this.configuration).v1ConfigsConfigIdCodeReferencesGet(configId, options).then((request) => request(this.axios, this.basePath)); - } - /** * * @summary Get References for Feature Flag or Setting diff --git a/api/configs-api.ts b/api/configs-api.ts index 13cb931..a9810c7 100644 --- a/api/configs-api.ts +++ b/api/configs-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/environments-api.ts b/api/environments-api.ts index 9a2fd3f..da975f6 100644 --- a/api/environments-api.ts +++ b/api/environments-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/feature-flag-setting-values-api.ts b/api/feature-flag-setting-values-api.ts index 3839c37..dd456cc 100644 --- a/api/feature-flag-setting-values-api.ts +++ b/api/feature-flag-setting-values-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -38,7 +38,7 @@ import { UpdateSettingValuesWithIdModel } from '../model'; export const FeatureFlagSettingValuesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview). * @summary Get value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -80,7 +80,7 @@ export const FeatureFlagSettingValuesApiAxiosParamCreator = function (configurat }; }, /** - * This endpoint returns the value of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). * @summary Get values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -122,7 +122,7 @@ export const FeatureFlagSettingValuesApiAxiosParamCreator = function (configurat }; }, /** - * This endpoint replaces the values of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. + * This endpoint replaces the values of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. * @summary Post values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -175,7 +175,7 @@ export const FeatureFlagSettingValuesApiAxiosParamCreator = function (configurat }; }, /** - * This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. + * This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. * @summary Replace value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -291,7 +291,7 @@ export const FeatureFlagSettingValuesApiFp = function(configuration?: Configurat const localVarAxiosParamCreator = FeatureFlagSettingValuesApiAxiosParamCreator(configuration) return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview). * @summary Get value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -305,7 +305,7 @@ export const FeatureFlagSettingValuesApiFp = function(configuration?: Configurat return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * This endpoint returns the value of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). * @summary Get values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -319,7 +319,7 @@ export const FeatureFlagSettingValuesApiFp = function(configuration?: Configurat return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * This endpoint replaces the values of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. + * This endpoint replaces the values of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. * @summary Post values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -335,7 +335,7 @@ export const FeatureFlagSettingValuesApiFp = function(configuration?: Configurat return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. + * This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. * @summary Replace value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -377,7 +377,7 @@ export const FeatureFlagSettingValuesApiFactory = function (configuration?: Conf const localVarFp = FeatureFlagSettingValuesApiFp(configuration) return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview). * @summary Get value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -388,7 +388,7 @@ export const FeatureFlagSettingValuesApiFactory = function (configuration?: Conf return localVarFp.getSettingValue(environmentId, settingId, options).then((request) => request(axios, basePath)); }, /** - * This endpoint returns the value of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). * @summary Get values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -399,7 +399,7 @@ export const FeatureFlagSettingValuesApiFactory = function (configuration?: Conf return localVarFp.getSettingValues(configId, environmentId, options).then((request) => request(axios, basePath)); }, /** - * This endpoint replaces the values of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. + * This endpoint replaces the values of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. * @summary Post values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -412,7 +412,7 @@ export const FeatureFlagSettingValuesApiFactory = function (configuration?: Conf return localVarFp.postSettingValues(configId, environmentId, updateSettingValuesWithIdModel, reason, options).then((request) => request(axios, basePath)); }, /** - * This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. + * This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. * @summary Replace value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -448,7 +448,7 @@ export const FeatureFlagSettingValuesApiFactory = function (configuration?: Conf */ export class FeatureFlagSettingValuesApi extends BaseAPI { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview). * @summary Get value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -461,7 +461,7 @@ export class FeatureFlagSettingValuesApi extends BaseAPI { } /** - * This endpoint returns the value of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). * @summary Get values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -474,7 +474,7 @@ export class FeatureFlagSettingValuesApi extends BaseAPI { } /** - * This endpoint replaces the values of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. + * This endpoint replaces the values of a specified Config\'s Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false, \"settingId\": 1 } ] } ``` If we send a replace request body as below: ```json { \"settingValues\": [ { \"value\": true, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true, \"setting\": { \"settingId\": 1 } } ] } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. * @summary Post values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -489,7 +489,7 @@ export class FeatureFlagSettingValuesApi extends BaseAPI { } /** - * This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. + * This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required. * @summary Replace value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. diff --git a/api/feature-flag-setting-values-using-sdkkey-api.ts b/api/feature-flag-setting-values-using-sdkkey-api.ts index 5307f2f..81e0176 100644 --- a/api/feature-flag-setting-values-using-sdkkey-api.ts +++ b/api/feature-flag-setting-values-using-sdkkey-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -34,7 +34,7 @@ import { UpdateSettingValueModel } from '../model'; export const FeatureFlagSettingValuesUsingSDKKeyApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). * @summary Get value * @param {string} settingKeyOrId The key or id of the Setting. * @param {string} [xCONFIGCATSDKKEY] The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) @@ -77,7 +77,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyApiAxiosParamCreator = function }; }, /** - * This endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` + * This endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` * @summary Replace value * @param {string} settingKeyOrId The key or id of the Setting. * @param {UpdateSettingValueModel} updateSettingValueModel @@ -195,7 +195,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyApiFp = function(configuration?: const localVarAxiosParamCreator = FeatureFlagSettingValuesUsingSDKKeyApiAxiosParamCreator(configuration) return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). * @summary Get value * @param {string} settingKeyOrId The key or id of the Setting. * @param {string} [xCONFIGCATSDKKEY] The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) @@ -209,7 +209,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyApiFp = function(configuration?: return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * This endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` + * This endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` * @summary Replace value * @param {string} settingKeyOrId The key or id of the Setting. * @param {UpdateSettingValueModel} updateSettingValueModel @@ -251,7 +251,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyApiFactory = function (configura const localVarFp = FeatureFlagSettingValuesUsingSDKKeyApiFp(configuration) return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). * @summary Get value * @param {string} settingKeyOrId The key or id of the Setting. * @param {string} [xCONFIGCATSDKKEY] The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) @@ -262,7 +262,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyApiFactory = function (configura return localVarFp.getSettingValueBySdkkey(settingKeyOrId, xCONFIGCATSDKKEY, options).then((request) => request(axios, basePath)); }, /** - * This endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` + * This endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` * @summary Replace value * @param {string} settingKeyOrId The key or id of the Setting. * @param {UpdateSettingValueModel} updateSettingValueModel @@ -298,7 +298,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyApiFactory = function (configura */ export class FeatureFlagSettingValuesUsingSDKKeyApi extends BaseAPI { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). * @summary Get value * @param {string} settingKeyOrId The key or id of the Setting. * @param {string} [xCONFIGCATSDKKEY] The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) @@ -311,7 +311,7 @@ export class FeatureFlagSettingValuesUsingSDKKeyApi extends BaseAPI { } /** - * This endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` + * This endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ``` * @summary Replace value * @param {string} settingKeyOrId The key or id of the Setting. * @param {UpdateSettingValueModel} updateSettingValueModel diff --git a/api/feature-flag-setting-values-using-sdkkey-v2-api.ts b/api/feature-flag-setting-values-using-sdkkey-v2-api.ts index a3b0bb8..f4b0875 100644 --- a/api/feature-flag-setting-values-using-sdkkey-v2-api.ts +++ b/api/feature-flag-setting-values-using-sdkkey-v2-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -34,7 +34,7 @@ import { UpdateEvaluationFormulaModel } from '../model'; export const FeatureFlagSettingValuesUsingSDKKeyV2ApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. * @summary Get value * @param {string} settingKeyOrId The key or id of the Setting. * @param {string} [xCONFIGCATSDKKEY] The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) @@ -77,7 +77,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyV2ApiAxiosParamCreator = functio }; }, /** - * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` + * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` * @summary Replace value * @param {string} settingKeyOrId The key or id of the Setting. * @param {UpdateEvaluationFormulaModel} updateEvaluationFormulaModel @@ -195,7 +195,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyV2ApiFp = function(configuration const localVarAxiosParamCreator = FeatureFlagSettingValuesUsingSDKKeyV2ApiAxiosParamCreator(configuration) return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. * @summary Get value * @param {string} settingKeyOrId The key or id of the Setting. * @param {string} [xCONFIGCATSDKKEY] The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) @@ -209,7 +209,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyV2ApiFp = function(configuration return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` + * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` * @summary Replace value * @param {string} settingKeyOrId The key or id of the Setting. * @param {UpdateEvaluationFormulaModel} updateEvaluationFormulaModel @@ -251,7 +251,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyV2ApiFactory = function (configu const localVarFp = FeatureFlagSettingValuesUsingSDKKeyV2ApiFp(configuration) return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. * @summary Get value * @param {string} settingKeyOrId The key or id of the Setting. * @param {string} [xCONFIGCATSDKKEY] The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) @@ -262,7 +262,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyV2ApiFactory = function (configu return localVarFp.getSettingValueBySdkkeyV2(settingKeyOrId, xCONFIGCATSDKKEY, options).then((request) => request(axios, basePath)); }, /** - * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` + * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` * @summary Replace value * @param {string} settingKeyOrId The key or id of the Setting. * @param {UpdateEvaluationFormulaModel} updateEvaluationFormulaModel @@ -298,7 +298,7 @@ export const FeatureFlagSettingValuesUsingSDKKeyV2ApiFactory = function (configu */ export class FeatureFlagSettingValuesUsingSDKKeyV2Api extends BaseAPI { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. * @summary Get value * @param {string} settingKeyOrId The key or id of the Setting. * @param {string} [xCONFIGCATSDKKEY] The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) @@ -311,7 +311,7 @@ export class FeatureFlagSettingValuesUsingSDKKeyV2Api extends BaseAPI { } /** - * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` + * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` * @summary Replace value * @param {string} settingKeyOrId The key or id of the Setting. * @param {UpdateEvaluationFormulaModel} updateEvaluationFormulaModel diff --git a/api/feature-flag-setting-values-v2-api.ts b/api/feature-flag-setting-values-v2-api.ts index 8ef3cf5..d6a3f6e 100644 --- a/api/feature-flag-setting-values-v2-api.ts +++ b/api/feature-flag-setting-values-v2-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -38,7 +38,7 @@ import { UpdateEvaluationFormulasModel } from '../model'; export const FeatureFlagSettingValuesV2ApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting. * @summary Get value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -80,7 +80,7 @@ export const FeatureFlagSettingValuesV2ApiAxiosParamCreator = function (configur }; }, /** - * This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting. * @summary Get values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -122,7 +122,7 @@ export const FeatureFlagSettingValuesV2ApiAxiosParamCreator = function (configur }; }, /** - * This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It\'s important to set every other field that you don\'t want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ``` + * This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It\'s important to set every other field that you don\'t want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"updateFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ``` * @summary Post values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -175,7 +175,7 @@ export const FeatureFlagSettingValuesV2ApiAxiosParamCreator = function (configur }; }, /** - * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` + * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` * @summary Replace value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -291,7 +291,7 @@ export const FeatureFlagSettingValuesV2ApiFp = function(configuration?: Configur const localVarAxiosParamCreator = FeatureFlagSettingValuesV2ApiAxiosParamCreator(configuration) return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting. * @summary Get value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -305,7 +305,7 @@ export const FeatureFlagSettingValuesV2ApiFp = function(configuration?: Configur return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting. * @summary Get values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -319,7 +319,7 @@ export const FeatureFlagSettingValuesV2ApiFp = function(configuration?: Configur return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It\'s important to set every other field that you don\'t want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ``` + * This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It\'s important to set every other field that you don\'t want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"updateFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ``` * @summary Post values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -335,7 +335,7 @@ export const FeatureFlagSettingValuesV2ApiFp = function(configuration?: Configur return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` + * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` * @summary Replace value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -377,7 +377,7 @@ export const FeatureFlagSettingValuesV2ApiFactory = function (configuration?: Co const localVarFp = FeatureFlagSettingValuesV2ApiFp(configuration) return { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting. * @summary Get value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -388,7 +388,7 @@ export const FeatureFlagSettingValuesV2ApiFactory = function (configuration?: Co return localVarFp.getSettingValueV2(environmentId, settingId, options).then((request) => request(axios, basePath)); }, /** - * This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting. * @summary Get values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -399,7 +399,7 @@ export const FeatureFlagSettingValuesV2ApiFactory = function (configuration?: Co return localVarFp.getSettingValuesV2(configId, environmentId, options).then((request) => request(axios, basePath)); }, /** - * This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It\'s important to set every other field that you don\'t want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ``` + * This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It\'s important to set every other field that you don\'t want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"updateFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ``` * @summary Post values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -412,7 +412,7 @@ export const FeatureFlagSettingValuesV2ApiFactory = function (configuration?: Co return localVarFp.postSettingValuesV2(configId, environmentId, updateEvaluationFormulasModel, reason, options).then((request) => request(axios, basePath)); }, /** - * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` + * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` * @summary Replace value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -448,7 +448,7 @@ export const FeatureFlagSettingValuesV2ApiFactory = function (configuration?: Co */ export class FeatureFlagSettingValuesV2Api extends BaseAPI { /** - * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting. * @summary Get value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. @@ -461,7 +461,7 @@ export class FeatureFlagSettingValuesV2Api extends BaseAPI { } /** - * This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/advanced/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting. + * This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting. * @summary Get values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -474,7 +474,7 @@ export class FeatureFlagSettingValuesV2Api extends BaseAPI { } /** - * This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It\'s important to set every other field that you don\'t want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingValues\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ``` + * This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It\'s important to set every other field that you don\'t want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"updateFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ``` * @summary Post values * @param {string} configId The identifier of the Config. * @param {string} environmentId The identifier of the Environment. @@ -489,7 +489,7 @@ export class FeatureFlagSettingValuesV2Api extends BaseAPI { } /** - * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` + * This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the SDK key passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other field that you don\'t want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ``` * @summary Replace value * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. diff --git a/api/feature-flags-settings-api.ts b/api/feature-flags-settings-api.ts index 6610368..37c3f35 100644 --- a/api/feature-flags-settings-api.ts +++ b/api/feature-flags-settings-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -26,6 +26,8 @@ import { CreateSettingInitialValues } from '../model'; // @ts-ignore import { JsonPatchOperation } from '../model'; // @ts-ignore +import { ReplaceSettingModel } from '../model'; +// @ts-ignore import { SettingModel } from '../model'; /** * FeatureFlagsSettingsApi - axios parameter creator @@ -192,7 +194,51 @@ export const FeatureFlagsSettingsApiAxiosParamCreator = function (configuration? }; }, /** - * This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ``` { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the name and adds the already existing tag with the id 2): ``` [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are going to be updated and all the other attributes are remaining unchanged. So we get a response like this: ``` { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ``` + * This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. + * @summary Replace Flag + * @param {number} settingId The identifier of the Setting. + * @param {ReplaceSettingModel} replaceSettingModel + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + replaceSetting: async (settingId: number, replaceSettingModel: ReplaceSettingModel, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'settingId' is not null or undefined + assertParamExists('replaceSetting', 'settingId', settingId) + // verify required parameter 'replaceSettingModel' is not null or undefined + assertParamExists('replaceSetting', 'replaceSettingModel', replaceSettingModel) + const localVarPath = `/v1/settings/{settingId}` + .replace(`{${"settingId"}}`, encodeURIComponent(String(settingId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(replaceSettingModel, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the `name` and adds the already existing tag with the id `2`): ```json [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ``` * @summary Update Flag * @param {number} settingId The identifier of the Setting. * @param {Array} jsonPatchOperation @@ -299,7 +345,21 @@ export const FeatureFlagsSettingsApiFp = function(configuration?: Configuration) return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ``` { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the name and adds the already existing tag with the id 2): ``` [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are going to be updated and all the other attributes are remaining unchanged. So we get a response like this: ``` { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ``` + * This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. + * @summary Replace Flag + * @param {number} settingId The identifier of the Setting. + * @param {ReplaceSettingModel} replaceSettingModel + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async replaceSetting(settingId: number, replaceSettingModel: ReplaceSettingModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.replaceSetting(settingId, replaceSettingModel, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['FeatureFlagsSettingsApi.replaceSetting']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the `name` and adds the already existing tag with the id `2`): ```json [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ``` * @summary Update Flag * @param {number} settingId The identifier of the Setting. * @param {Array} jsonPatchOperation @@ -364,7 +424,18 @@ export const FeatureFlagsSettingsApiFactory = function (configuration?: Configur return localVarFp.getSettings(configId, options).then((request) => request(axios, basePath)); }, /** - * This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ``` { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the name and adds the already existing tag with the id 2): ``` [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are going to be updated and all the other attributes are remaining unchanged. So we get a response like this: ``` { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ``` + * This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. + * @summary Replace Flag + * @param {number} settingId The identifier of the Setting. + * @param {ReplaceSettingModel} replaceSettingModel + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + replaceSetting(settingId: number, replaceSettingModel: ReplaceSettingModel, options?: any): AxiosPromise { + return localVarFp.replaceSetting(settingId, replaceSettingModel, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the `name` and adds the already existing tag with the id `2`): ```json [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ``` * @summary Update Flag * @param {number} settingId The identifier of the Setting. * @param {Array} jsonPatchOperation @@ -434,7 +505,20 @@ export class FeatureFlagsSettingsApi extends BaseAPI { } /** - * This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ``` { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the name and adds the already existing tag with the id 2): ``` [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are going to be updated and all the other attributes are remaining unchanged. So we get a response like this: ``` { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ``` + * This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. + * @summary Replace Flag + * @param {number} settingId The identifier of the Setting. + * @param {ReplaceSettingModel} replaceSettingModel + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FeatureFlagsSettingsApi + */ + public replaceSetting(settingId: number, replaceSettingModel: ReplaceSettingModel, options?: RawAxiosRequestConfig) { + return FeatureFlagsSettingsApiFp(this.configuration).replaceSetting(settingId, replaceSettingModel, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the `name` and adds the already existing tag with the id `2`): ```json [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ``` * @summary Update Flag * @param {number} settingId The identifier of the Setting. * @param {Array} jsonPatchOperation diff --git a/api/integration-links-api.ts b/api/integration-links-api.ts index d86195e..6b18ac3 100644 --- a/api/integration-links-api.ts +++ b/api/integration-links-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/integrations-api.ts b/api/integrations-api.ts new file mode 100644 index 0000000..9e6a63a --- /dev/null +++ b/api/integrations-api.ts @@ -0,0 +1,451 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; +// @ts-ignore +import { CreateIntegrationModel } from '../model'; +// @ts-ignore +import { IntegrationModel } from '../model'; +// @ts-ignore +import { IntegrationsModel } from '../model'; +// @ts-ignore +import { ModifyIntegrationRequest } from '../model'; +/** + * IntegrationsApi - axios parameter creator + * @export + */ +export const IntegrationsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This endpoint creates a new Integration in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress) + * @summary Create Integration + * @param {string} productId The identifier of the Product. + * @param {CreateIntegrationModel} createIntegrationModel + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createIntegration: async (productId: string, createIntegrationModel: CreateIntegrationModel, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('createIntegration', 'productId', productId) + // verify required parameter 'createIntegrationModel' is not null or undefined + assertParamExists('createIntegration', 'createIntegrationModel', createIntegrationModel) + const localVarPath = `/v1/products/{productId}/integrations` + .replace(`{${"productId"}}`, encodeURIComponent(String(productId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createIntegrationModel, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint removes a Integration identified by the `integrationId` parameter. + * @summary Delete Integration + * @param {string} integrationId The identifier of the Integration. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteIntegration: async (integrationId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'integrationId' is not null or undefined + assertParamExists('deleteIntegration', 'integrationId', integrationId) + const localVarPath = `/v1/integrations/{integrationId}` + .replace(`{${"integrationId"}}`, encodeURIComponent(String(integrationId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the metadata of an Integration identified by the `integrationId`. + * @summary Get Integration + * @param {string} integrationId The identifier of the Integration. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getIntegration: async (integrationId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'integrationId' is not null or undefined + assertParamExists('getIntegration', 'integrationId', integrationId) + const localVarPath = `/v1/integrations/{integrationId}` + .replace(`{${"integrationId"}}`, encodeURIComponent(String(integrationId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the list of the Integrations that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary List Integrations + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getIntegrations: async (productId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('getIntegrations', 'productId', productId) + const localVarPath = `/v1/products/{productId}/integrations` + .replace(`{${"productId"}}`, encodeURIComponent(String(productId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint updates a Config identified by the `integrationId` parameter. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress) + * @summary Update Integration + * @param {string} integrationId The identifier of the Integration. + * @param {ModifyIntegrationRequest} modifyIntegrationRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateIntegration: async (integrationId: string, modifyIntegrationRequest: ModifyIntegrationRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'integrationId' is not null or undefined + assertParamExists('updateIntegration', 'integrationId', integrationId) + // verify required parameter 'modifyIntegrationRequest' is not null or undefined + assertParamExists('updateIntegration', 'modifyIntegrationRequest', modifyIntegrationRequest) + const localVarPath = `/v1/integrations/{integrationId}` + .replace(`{${"integrationId"}}`, encodeURIComponent(String(integrationId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(modifyIntegrationRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * IntegrationsApi - functional programming interface + * @export + */ +export const IntegrationsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IntegrationsApiAxiosParamCreator(configuration) + return { + /** + * This endpoint creates a new Integration in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress) + * @summary Create Integration + * @param {string} productId The identifier of the Product. + * @param {CreateIntegrationModel} createIntegrationModel + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createIntegration(productId: string, createIntegrationModel: CreateIntegrationModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createIntegration(productId, createIntegrationModel, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IntegrationsApi.createIntegration']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint removes a Integration identified by the `integrationId` parameter. + * @summary Delete Integration + * @param {string} integrationId The identifier of the Integration. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteIntegration(integrationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIntegration(integrationId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IntegrationsApi.deleteIntegration']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the metadata of an Integration identified by the `integrationId`. + * @summary Get Integration + * @param {string} integrationId The identifier of the Integration. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getIntegration(integrationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIntegration(integrationId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IntegrationsApi.getIntegration']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the list of the Integrations that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary List Integrations + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getIntegrations(productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIntegrations(productId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IntegrationsApi.getIntegrations']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint updates a Config identified by the `integrationId` parameter. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress) + * @summary Update Integration + * @param {string} integrationId The identifier of the Integration. + * @param {ModifyIntegrationRequest} modifyIntegrationRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateIntegration(integrationId: string, modifyIntegrationRequest: ModifyIntegrationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateIntegration(integrationId, modifyIntegrationRequest, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IntegrationsApi.updateIntegration']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IntegrationsApi - factory interface + * @export + */ +export const IntegrationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IntegrationsApiFp(configuration) + return { + /** + * This endpoint creates a new Integration in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress) + * @summary Create Integration + * @param {string} productId The identifier of the Product. + * @param {CreateIntegrationModel} createIntegrationModel + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createIntegration(productId: string, createIntegrationModel: CreateIntegrationModel, options?: any): AxiosPromise { + return localVarFp.createIntegration(productId, createIntegrationModel, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint removes a Integration identified by the `integrationId` parameter. + * @summary Delete Integration + * @param {string} integrationId The identifier of the Integration. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteIntegration(integrationId: string, options?: any): AxiosPromise { + return localVarFp.deleteIntegration(integrationId, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the metadata of an Integration identified by the `integrationId`. + * @summary Get Integration + * @param {string} integrationId The identifier of the Integration. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getIntegration(integrationId: string, options?: any): AxiosPromise { + return localVarFp.getIntegration(integrationId, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the list of the Integrations that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary List Integrations + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getIntegrations(productId: string, options?: any): AxiosPromise { + return localVarFp.getIntegrations(productId, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint updates a Config identified by the `integrationId` parameter. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress) + * @summary Update Integration + * @param {string} integrationId The identifier of the Integration. + * @param {ModifyIntegrationRequest} modifyIntegrationRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateIntegration(integrationId: string, modifyIntegrationRequest: ModifyIntegrationRequest, options?: any): AxiosPromise { + return localVarFp.updateIntegration(integrationId, modifyIntegrationRequest, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * IntegrationsApi - object-oriented interface + * @export + * @class IntegrationsApi + * @extends {BaseAPI} + */ +export class IntegrationsApi extends BaseAPI { + /** + * This endpoint creates a new Integration in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress) + * @summary Create Integration + * @param {string} productId The identifier of the Product. + * @param {CreateIntegrationModel} createIntegrationModel + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof IntegrationsApi + */ + public createIntegration(productId: string, createIntegrationModel: CreateIntegrationModel, options?: RawAxiosRequestConfig) { + return IntegrationsApiFp(this.configuration).createIntegration(productId, createIntegrationModel, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint removes a Integration identified by the `integrationId` parameter. + * @summary Delete Integration + * @param {string} integrationId The identifier of the Integration. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof IntegrationsApi + */ + public deleteIntegration(integrationId: string, options?: RawAxiosRequestConfig) { + return IntegrationsApiFp(this.configuration).deleteIntegration(integrationId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the metadata of an Integration identified by the `integrationId`. + * @summary Get Integration + * @param {string} integrationId The identifier of the Integration. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof IntegrationsApi + */ + public getIntegration(integrationId: string, options?: RawAxiosRequestConfig) { + return IntegrationsApiFp(this.configuration).getIntegration(integrationId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the list of the Integrations that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary List Integrations + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof IntegrationsApi + */ + public getIntegrations(productId: string, options?: RawAxiosRequestConfig) { + return IntegrationsApiFp(this.configuration).getIntegrations(productId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint updates a Config identified by the `integrationId` parameter. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress) + * @summary Update Integration + * @param {string} integrationId The identifier of the Integration. + * @param {ModifyIntegrationRequest} modifyIntegrationRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof IntegrationsApi + */ + public updateIntegration(integrationId: string, modifyIntegrationRequest: ModifyIntegrationRequest, options?: RawAxiosRequestConfig) { + return IntegrationsApiFp(this.configuration).updateIntegration(integrationId, modifyIntegrationRequest, options).then((request) => request(this.axios, this.basePath)); + } +} + diff --git a/api/me-api.ts b/api/me-api.ts index 60c7863..0a68329 100644 --- a/api/me-api.ts +++ b/api/me-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/members-api.ts b/api/members-api.ts index cbe23b3..4701376 100644 --- a/api/members-api.ts +++ b/api/members-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -22,14 +22,18 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore -import { AddUserToGroupRequest } from '../model'; +import { InvitationModel } from '../model'; // @ts-ignore import { InviteMembersRequest } from '../model'; // @ts-ignore import { MemberModel } from '../model'; // @ts-ignore +import { OrganizationInvitationModel } from '../model'; +// @ts-ignore import { OrganizationMembersModel } from '../model'; // @ts-ignore +import { UpdateMemberPermissionsRequest } from '../model'; +// @ts-ignore import { UserModel } from '../model'; /** * MembersApi - axios parameter creator @@ -38,21 +42,21 @@ import { UserModel } from '../model'; export const MembersApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * This endpoint adds a Member identified by the `userId` to one or more Permission Groups. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product. + * This endpoint updates the permissions of a Member identified by the `userId`. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product. * @summary Update Member Permissions * @param {string} organizationId The identifier of the Organization. * @param {string} userId The identifier of the Member. - * @param {AddUserToGroupRequest} addUserToGroupRequest + * @param {UpdateMemberPermissionsRequest} updateMemberPermissionsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addMemberToGroup: async (organizationId: string, userId: string, addUserToGroupRequest: AddUserToGroupRequest, options: RawAxiosRequestConfig = {}): Promise => { + addMemberToGroup: async (organizationId: string, userId: string, updateMemberPermissionsRequest: UpdateMemberPermissionsRequest, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'organizationId' is not null or undefined assertParamExists('addMemberToGroup', 'organizationId', organizationId) // verify required parameter 'userId' is not null or undefined assertParamExists('addMemberToGroup', 'userId', userId) - // verify required parameter 'addUserToGroupRequest' is not null or undefined - assertParamExists('addMemberToGroup', 'addUserToGroupRequest', addUserToGroupRequest) + // verify required parameter 'updateMemberPermissionsRequest' is not null or undefined + assertParamExists('addMemberToGroup', 'updateMemberPermissionsRequest', updateMemberPermissionsRequest) const localVarPath = `/v1/organizations/{organizationId}/members/{userId}` .replace(`{${"organizationId"}}`, encodeURIComponent(String(organizationId))) .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); @@ -78,7 +82,45 @@ export const MembersApiAxiosParamCreator = function (configuration?: Configurati setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(addUserToGroupRequest, localVarRequestOptions, configuration) + localVarRequestOptions.data = serializeDataIfNeeded(updateMemberPermissionsRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint removes an Invitation identified by the `invitationId` parameter. + * @summary Delete Invitation + * @param {string} invitationId The identifier of the Invitation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteInvitation: async (invitationId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'invitationId' is not null or undefined + assertParamExists('deleteInvitation', 'invitationId', invitationId) + const localVarPath = `/v1/invitations/{invitationId}` + .replace(`{${"invitationId"}}`, encodeURIComponent(String(invitationId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), @@ -237,6 +279,82 @@ export const MembersApiAxiosParamCreator = function (configuration?: Configurati + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter. + * @summary List Pending Invitations in Product + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPendingInvitations: async (productId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('getPendingInvitations', 'productId', productId) + const localVarPath = `/v1/products/{productId}/invitations` + .replace(`{${"productId"}}`, encodeURIComponent(String(productId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter. + * @summary List Pending Invitations in Organization + * @param {string} organizationId The identifier of the Organization. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPendingInvitationsOrg: async (organizationId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'organizationId' is not null or undefined + assertParamExists('getPendingInvitationsOrg', 'organizationId', organizationId) + const localVarPath = `/v1/organizations/{organizationId}/invitations` + .replace(`{${"organizationId"}}`, encodeURIComponent(String(organizationId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -339,20 +457,33 @@ export const MembersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MembersApiAxiosParamCreator(configuration) return { /** - * This endpoint adds a Member identified by the `userId` to one or more Permission Groups. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product. + * This endpoint updates the permissions of a Member identified by the `userId`. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product. * @summary Update Member Permissions * @param {string} organizationId The identifier of the Organization. * @param {string} userId The identifier of the Member. - * @param {AddUserToGroupRequest} addUserToGroupRequest + * @param {UpdateMemberPermissionsRequest} updateMemberPermissionsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async addMemberToGroup(organizationId: string, userId: string, addUserToGroupRequest: AddUserToGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addMemberToGroup(organizationId, userId, addUserToGroupRequest, options); + async addMemberToGroup(organizationId: string, userId: string, updateMemberPermissionsRequest: UpdateMemberPermissionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addMemberToGroup(organizationId, userId, updateMemberPermissionsRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MembersApi.addMemberToGroup']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * This endpoint removes an Invitation identified by the `invitationId` parameter. + * @summary Delete Invitation + * @param {string} invitationId The identifier of the Invitation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteInvitation(invitationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteInvitation(invitationId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MembersApi.deleteInvitation']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter. * @summary Delete Member from Organization @@ -408,6 +539,32 @@ export const MembersApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['MembersApi.getOrganizationMembersV2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter. + * @summary List Pending Invitations in Product + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getPendingInvitations(productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingInvitations(productId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MembersApi.getPendingInvitations']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter. + * @summary List Pending Invitations in Organization + * @param {string} organizationId The identifier of the Organization. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getPendingInvitationsOrg(organizationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingInvitationsOrg(organizationId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MembersApi.getPendingInvitationsOrg']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter. * @summary List Product Members @@ -446,16 +603,26 @@ export const MembersApiFactory = function (configuration?: Configuration, basePa const localVarFp = MembersApiFp(configuration) return { /** - * This endpoint adds a Member identified by the `userId` to one or more Permission Groups. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product. + * This endpoint updates the permissions of a Member identified by the `userId`. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product. * @summary Update Member Permissions * @param {string} organizationId The identifier of the Organization. * @param {string} userId The identifier of the Member. - * @param {AddUserToGroupRequest} addUserToGroupRequest + * @param {UpdateMemberPermissionsRequest} updateMemberPermissionsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addMemberToGroup(organizationId: string, userId: string, addUserToGroupRequest: AddUserToGroupRequest, options?: any): AxiosPromise { - return localVarFp.addMemberToGroup(organizationId, userId, addUserToGroupRequest, options).then((request) => request(axios, basePath)); + addMemberToGroup(organizationId: string, userId: string, updateMemberPermissionsRequest: UpdateMemberPermissionsRequest, options?: any): AxiosPromise { + return localVarFp.addMemberToGroup(organizationId, userId, updateMemberPermissionsRequest, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint removes an Invitation identified by the `invitationId` parameter. + * @summary Delete Invitation + * @param {string} invitationId The identifier of the Invitation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteInvitation(invitationId: string, options?: any): AxiosPromise { + return localVarFp.deleteInvitation(invitationId, options).then((request) => request(axios, basePath)); }, /** * This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter. @@ -500,6 +667,26 @@ export const MembersApiFactory = function (configuration?: Configuration, basePa getOrganizationMembersV2(organizationId: string, options?: any): AxiosPromise { return localVarFp.getOrganizationMembersV2(organizationId, options).then((request) => request(axios, basePath)); }, + /** + * This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter. + * @summary List Pending Invitations in Product + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPendingInvitations(productId: string, options?: any): AxiosPromise> { + return localVarFp.getPendingInvitations(productId, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter. + * @summary List Pending Invitations in Organization + * @param {string} organizationId The identifier of the Organization. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPendingInvitationsOrg(organizationId: string, options?: any): AxiosPromise> { + return localVarFp.getPendingInvitationsOrg(organizationId, options).then((request) => request(axios, basePath)); + }, /** * This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter. * @summary List Product Members @@ -532,17 +719,29 @@ export const MembersApiFactory = function (configuration?: Configuration, basePa */ export class MembersApi extends BaseAPI { /** - * This endpoint adds a Member identified by the `userId` to one or more Permission Groups. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product. + * This endpoint updates the permissions of a Member identified by the `userId`. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product. * @summary Update Member Permissions * @param {string} organizationId The identifier of the Organization. * @param {string} userId The identifier of the Member. - * @param {AddUserToGroupRequest} addUserToGroupRequest + * @param {UpdateMemberPermissionsRequest} updateMemberPermissionsRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof MembersApi + */ + public addMemberToGroup(organizationId: string, userId: string, updateMemberPermissionsRequest: UpdateMemberPermissionsRequest, options?: RawAxiosRequestConfig) { + return MembersApiFp(this.configuration).addMemberToGroup(organizationId, userId, updateMemberPermissionsRequest, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint removes an Invitation identified by the `invitationId` parameter. + * @summary Delete Invitation + * @param {string} invitationId The identifier of the Invitation. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ - public addMemberToGroup(organizationId: string, userId: string, addUserToGroupRequest: AddUserToGroupRequest, options?: RawAxiosRequestConfig) { - return MembersApiFp(this.configuration).addMemberToGroup(organizationId, userId, addUserToGroupRequest, options).then((request) => request(this.axios, this.basePath)); + public deleteInvitation(invitationId: string, options?: RawAxiosRequestConfig) { + return MembersApiFp(this.configuration).deleteInvitation(invitationId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -596,6 +795,30 @@ export class MembersApi extends BaseAPI { return MembersApiFp(this.configuration).getOrganizationMembersV2(organizationId, options).then((request) => request(this.axios, this.basePath)); } + /** + * This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter. + * @summary List Pending Invitations in Product + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof MembersApi + */ + public getPendingInvitations(productId: string, options?: RawAxiosRequestConfig) { + return MembersApiFp(this.configuration).getPendingInvitations(productId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter. + * @summary List Pending Invitations in Organization + * @param {string} organizationId The identifier of the Organization. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof MembersApi + */ + public getPendingInvitationsOrg(organizationId: string, options?: RawAxiosRequestConfig) { + return MembersApiFp(this.configuration).getPendingInvitationsOrg(organizationId, options).then((request) => request(this.axios, this.basePath)); + } + /** * This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter. * @summary List Product Members diff --git a/api/organizations-api.ts b/api/organizations-api.ts index b1044f0..e480f61 100644 --- a/api/organizations-api.ts +++ b/api/organizations-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/permission-groups-api.ts b/api/permission-groups-api.ts index f5f2026..7dc330d 100644 --- a/api/permission-groups-api.ts +++ b/api/permission-groups-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/products-api.ts b/api/products-api.ts index 42fa38f..502502d 100644 --- a/api/products-api.ts +++ b/api/products-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -24,8 +24,12 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, ope // @ts-ignore import { CreateProductRequest } from '../model'; // @ts-ignore +import { PreferencesModel } from '../model'; +// @ts-ignore import { ProductModel } from '../model'; // @ts-ignore +import { UpdatePreferencesRequest } from '../model'; +// @ts-ignore import { UpdateProductRequest } from '../model'; /** * ProductsApi - axios parameter creator @@ -144,6 +148,44 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the preferences of a Product identified by the `productId`. + * @summary Get Product Preferences + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getProductPreferences: async (productId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('getProductPreferences', 'productId', productId) + const localVarPath = `/v1/products/{productId}/preferences` + .replace(`{${"productId"}}`, encodeURIComponent(String(productId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -226,6 +268,50 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(updateProductRequest, localVarRequestOptions, configuration) + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint updates the preferences of a Product identified by the `productId` parameter. + * @summary Update Product Preferences + * @param {string} productId The identifier of the Product. + * @param {UpdatePreferencesRequest} updatePreferencesRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateProductPreferences: async (productId: string, updatePreferencesRequest: UpdatePreferencesRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('updateProductPreferences', 'productId', productId) + // verify required parameter 'updatePreferencesRequest' is not null or undefined + assertParamExists('updateProductPreferences', 'updatePreferencesRequest', updatePreferencesRequest) + const localVarPath = `/v1/products/{productId}/preferences` + .replace(`{${"productId"}}`, encodeURIComponent(String(productId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updatePreferencesRequest, localVarRequestOptions, configuration) + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -281,6 +367,19 @@ export const ProductsApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['ProductsApi.getProduct']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * This endpoint returns the preferences of a Product identified by the `productId`. + * @summary Get Product Preferences + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getProductPreferences(productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getProductPreferences(productId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ProductsApi.getProductPreferences']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * This endpoint returns the list of the Products that belongs to the user. * @summary List Products @@ -307,6 +406,20 @@ export const ProductsApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateProduct']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * This endpoint updates the preferences of a Product identified by the `productId` parameter. + * @summary Update Product Preferences + * @param {string} productId The identifier of the Product. + * @param {UpdatePreferencesRequest} updatePreferencesRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateProductPreferences(productId: string, updatePreferencesRequest: UpdatePreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateProductPreferences(productId, updatePreferencesRequest, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateProductPreferences']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, } }; @@ -348,6 +461,16 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP getProduct(productId: string, options?: any): AxiosPromise { return localVarFp.getProduct(productId, options).then((request) => request(axios, basePath)); }, + /** + * This endpoint returns the preferences of a Product identified by the `productId`. + * @summary Get Product Preferences + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getProductPreferences(productId: string, options?: any): AxiosPromise { + return localVarFp.getProductPreferences(productId, options).then((request) => request(axios, basePath)); + }, /** * This endpoint returns the list of the Products that belongs to the user. * @summary List Products @@ -368,6 +491,17 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP updateProduct(productId: string, updateProductRequest: UpdateProductRequest, options?: any): AxiosPromise { return localVarFp.updateProduct(productId, updateProductRequest, options).then((request) => request(axios, basePath)); }, + /** + * This endpoint updates the preferences of a Product identified by the `productId` parameter. + * @summary Update Product Preferences + * @param {string} productId The identifier of the Product. + * @param {UpdatePreferencesRequest} updatePreferencesRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateProductPreferences(productId: string, updatePreferencesRequest: UpdatePreferencesRequest, options?: any): AxiosPromise { + return localVarFp.updateProductPreferences(productId, updatePreferencesRequest, options).then((request) => request(axios, basePath)); + }, }; }; @@ -415,6 +549,18 @@ export class ProductsApi extends BaseAPI { return ProductsApiFp(this.configuration).getProduct(productId, options).then((request) => request(this.axios, this.basePath)); } + /** + * This endpoint returns the preferences of a Product identified by the `productId`. + * @summary Get Product Preferences + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProductsApi + */ + public getProductPreferences(productId: string, options?: RawAxiosRequestConfig) { + return ProductsApiFp(this.configuration).getProductPreferences(productId, options).then((request) => request(this.axios, this.basePath)); + } + /** * This endpoint returns the list of the Products that belongs to the user. * @summary List Products @@ -438,5 +584,18 @@ export class ProductsApi extends BaseAPI { public updateProduct(productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig) { return ProductsApiFp(this.configuration).updateProduct(productId, updateProductRequest, options).then((request) => request(this.axios, this.basePath)); } + + /** + * This endpoint updates the preferences of a Product identified by the `productId` parameter. + * @summary Update Product Preferences + * @param {string} productId The identifier of the Product. + * @param {UpdatePreferencesRequest} updatePreferencesRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProductsApi + */ + public updateProductPreferences(productId: string, updatePreferencesRequest: UpdatePreferencesRequest, options?: RawAxiosRequestConfig) { + return ProductsApiFp(this.configuration).updateProductPreferences(productId, updatePreferencesRequest, options).then((request) => request(this.axios, this.basePath)); + } } diff --git a/api/sdkkeys-api.ts b/api/sdkkeys-api.ts index 23270df..3d0d107 100644 --- a/api/sdkkeys-api.ts +++ b/api/sdkkeys-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/segments-api.ts b/api/segments-api.ts index b1aaf2c..34175ff 100644 --- a/api/segments-api.ts +++ b/api/segments-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/tags-api.ts b/api/tags-api.ts index 911b157..398332d 100644 --- a/api/tags-api.ts +++ b/api/tags-api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/api/webhooks-api.ts b/api/webhooks-api.ts new file mode 100644 index 0000000..bc9fcaf --- /dev/null +++ b/api/webhooks-api.ts @@ -0,0 +1,613 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; +// @ts-ignore +import { JsonPatchOperation } from '../model'; +// @ts-ignore +import { WebHookRequest } from '../model'; +// @ts-ignore +import { WebhookModel } from '../model'; +// @ts-ignore +import { WebhookSigningKeysModel } from '../model'; +/** + * WebhooksApi - axios parameter creator + * @export + */ +export const WebhooksApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary Create Webhook + * @param {string} configId The identifier of the Config. + * @param {string} environmentId The identifier of the Environment. + * @param {WebHookRequest} webHookRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createWebhook: async (configId: string, environmentId: string, webHookRequest: WebHookRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'configId' is not null or undefined + assertParamExists('createWebhook', 'configId', configId) + // verify required parameter 'environmentId' is not null or undefined + assertParamExists('createWebhook', 'environmentId', environmentId) + // verify required parameter 'webHookRequest' is not null or undefined + assertParamExists('createWebhook', 'webHookRequest', webHookRequest) + const localVarPath = `/v1/configs/{configId}/environments/{environmentId}/webhooks` + .replace(`{${"configId"}}`, encodeURIComponent(String(configId))) + .replace(`{${"environmentId"}}`, encodeURIComponent(String(environmentId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(webHookRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint removes a Webhook identified by the `webhookId` parameter. + * @summary Delete Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteWebhook: async (webhookId: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'webhookId' is not null or undefined + assertParamExists('deleteWebhook', 'webhookId', webhookId) + const localVarPath = `/v1/webhooks/{webhookId}` + .replace(`{${"webhookId"}}`, encodeURIComponent(String(webhookId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the metadata of a Webhook identified by the `webhookId`. + * @summary Get Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getWebhook: async (webhookId: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'webhookId' is not null or undefined + assertParamExists('getWebhook', 'webhookId', webhookId) + const localVarPath = `/v1/webhooks/{webhookId}` + .replace(`{${"webhookId"}}`, encodeURIComponent(String(webhookId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the signing keys of a Webhook identified by the `webhookId`. Signing keys are used for ensuring the Webhook requests you receive are actually sent by ConfigCat. Here you can read more about Webhook request verification. + * @summary Get Webhook Signing Keys + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getWebhookSigningKeys: async (webhookId: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'webhookId' is not null or undefined + assertParamExists('getWebhookSigningKeys', 'webhookId', webhookId) + const localVarPath = `/v1/webhooks/{webhookId}/keys` + .replace(`{${"webhookId"}}`, encodeURIComponent(String(webhookId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary List Webhooks + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getWebhooks: async (productId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('getWebhooks', 'productId', productId) + const localVarPath = `/v1/products/{productId}/webhooks` + .replace(`{${"productId"}}`, encodeURIComponent(String(productId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. + * @summary Replace Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {WebHookRequest} webHookRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + replaceWebhook: async (webhookId: number, webHookRequest: WebHookRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'webhookId' is not null or undefined + assertParamExists('replaceWebhook', 'webhookId', webhookId) + // verify required parameter 'webHookRequest' is not null or undefined + assertParamExists('replaceWebhook', 'webHookRequest', webHookRequest) + const localVarPath = `/v1/webhooks/{webhookId}` + .replace(`{${"webhookId"}}`, encodeURIComponent(String(webhookId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(webHookRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"null\", \"webHookHeaders\": [] } ``` If we send an update request body as below (it changes the `content` field and adds a new HTTP header): ```json [ { \"op\": \"replace\", \"path\": \"/content\", \"value\": \"Some webhook content.\" }, { \"op\": \"add\", \"path\": \"/webHookHeaders/-\", \"value\": { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\" } } ] ``` Only the `content` and `webHookHeaders` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"Some webhook content.\", \"webHookHeaders\": [ { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\", \"isSecure\": false } ] } ``` + * @summary Update Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {Array} jsonPatchOperation + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateWebhook: async (webhookId: number, jsonPatchOperation: Array, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'webhookId' is not null or undefined + assertParamExists('updateWebhook', 'webhookId', webhookId) + // verify required parameter 'jsonPatchOperation' is not null or undefined + assertParamExists('updateWebhook', 'jsonPatchOperation', jsonPatchOperation) + const localVarPath = `/v1/webhooks/{webhookId}` + .replace(`{${"webhookId"}}`, encodeURIComponent(String(webhookId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * WebhooksApi - functional programming interface + * @export + */ +export const WebhooksApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration) + return { + /** + * This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary Create Webhook + * @param {string} configId The identifier of the Config. + * @param {string} environmentId The identifier of the Environment. + * @param {WebHookRequest} webHookRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createWebhook(configId: string, environmentId: string, webHookRequest: WebHookRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createWebhook(configId, environmentId, webHookRequest, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WebhooksApi.createWebhook']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint removes a Webhook identified by the `webhookId` parameter. + * @summary Delete Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteWebhook(webhookId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWebhook(webhookId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WebhooksApi.deleteWebhook']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the metadata of a Webhook identified by the `webhookId`. + * @summary Get Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getWebhook(webhookId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWebhook(webhookId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WebhooksApi.getWebhook']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the signing keys of a Webhook identified by the `webhookId`. Signing keys are used for ensuring the Webhook requests you receive are actually sent by ConfigCat. Here you can read more about Webhook request verification. + * @summary Get Webhook Signing Keys + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getWebhookSigningKeys(webhookId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWebhookSigningKeys(webhookId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WebhooksApi.getWebhookSigningKeys']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary List Webhooks + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getWebhooks(productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWebhooks(productId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WebhooksApi.getWebhooks']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. + * @summary Replace Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {WebHookRequest} webHookRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async replaceWebhook(webhookId: number, webHookRequest: WebHookRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.replaceWebhook(webhookId, webHookRequest, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WebhooksApi.replaceWebhook']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"null\", \"webHookHeaders\": [] } ``` If we send an update request body as below (it changes the `content` field and adds a new HTTP header): ```json [ { \"op\": \"replace\", \"path\": \"/content\", \"value\": \"Some webhook content.\" }, { \"op\": \"add\", \"path\": \"/webHookHeaders/-\", \"value\": { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\" } } ] ``` Only the `content` and `webHookHeaders` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"Some webhook content.\", \"webHookHeaders\": [ { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\", \"isSecure\": false } ] } ``` + * @summary Update Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {Array} jsonPatchOperation + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateWebhook(webhookId: number, jsonPatchOperation: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateWebhook(webhookId, jsonPatchOperation, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WebhooksApi.updateWebhook']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * WebhooksApi - factory interface + * @export + */ +export const WebhooksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = WebhooksApiFp(configuration) + return { + /** + * This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary Create Webhook + * @param {string} configId The identifier of the Config. + * @param {string} environmentId The identifier of the Environment. + * @param {WebHookRequest} webHookRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createWebhook(configId: string, environmentId: string, webHookRequest: WebHookRequest, options?: any): AxiosPromise { + return localVarFp.createWebhook(configId, environmentId, webHookRequest, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint removes a Webhook identified by the `webhookId` parameter. + * @summary Delete Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteWebhook(webhookId: number, options?: any): AxiosPromise { + return localVarFp.deleteWebhook(webhookId, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the metadata of a Webhook identified by the `webhookId`. + * @summary Get Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getWebhook(webhookId: number, options?: any): AxiosPromise { + return localVarFp.getWebhook(webhookId, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the signing keys of a Webhook identified by the `webhookId`. Signing keys are used for ensuring the Webhook requests you receive are actually sent by ConfigCat. Here you can read more about Webhook request verification. + * @summary Get Webhook Signing Keys + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getWebhookSigningKeys(webhookId: number, options?: any): AxiosPromise { + return localVarFp.getWebhookSigningKeys(webhookId, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary List Webhooks + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getWebhooks(productId: string, options?: any): AxiosPromise> { + return localVarFp.getWebhooks(productId, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. + * @summary Replace Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {WebHookRequest} webHookRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + replaceWebhook(webhookId: number, webHookRequest: WebHookRequest, options?: any): AxiosPromise { + return localVarFp.replaceWebhook(webhookId, webHookRequest, options).then((request) => request(axios, basePath)); + }, + /** + * This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"null\", \"webHookHeaders\": [] } ``` If we send an update request body as below (it changes the `content` field and adds a new HTTP header): ```json [ { \"op\": \"replace\", \"path\": \"/content\", \"value\": \"Some webhook content.\" }, { \"op\": \"add\", \"path\": \"/webHookHeaders/-\", \"value\": { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\" } } ] ``` Only the `content` and `webHookHeaders` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"Some webhook content.\", \"webHookHeaders\": [ { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\", \"isSecure\": false } ] } ``` + * @summary Update Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {Array} jsonPatchOperation + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateWebhook(webhookId: number, jsonPatchOperation: Array, options?: any): AxiosPromise { + return localVarFp.updateWebhook(webhookId, jsonPatchOperation, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * WebhooksApi - object-oriented interface + * @export + * @class WebhooksApi + * @extends {BaseAPI} + */ +export class WebhooksApi extends BaseAPI { + /** + * This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary Create Webhook + * @param {string} configId The identifier of the Config. + * @param {string} environmentId The identifier of the Environment. + * @param {WebHookRequest} webHookRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public createWebhook(configId: string, environmentId: string, webHookRequest: WebHookRequest, options?: RawAxiosRequestConfig) { + return WebhooksApiFp(this.configuration).createWebhook(configId, environmentId, webHookRequest, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint removes a Webhook identified by the `webhookId` parameter. + * @summary Delete Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public deleteWebhook(webhookId: number, options?: RawAxiosRequestConfig) { + return WebhooksApiFp(this.configuration).deleteWebhook(webhookId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the metadata of a Webhook identified by the `webhookId`. + * @summary Get Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public getWebhook(webhookId: number, options?: RawAxiosRequestConfig) { + return WebhooksApiFp(this.configuration).getWebhook(webhookId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the signing keys of a Webhook identified by the `webhookId`. Signing keys are used for ensuring the Webhook requests you receive are actually sent by ConfigCat. Here you can read more about Webhook request verification. + * @summary Get Webhook Signing Keys + * @param {number} webhookId The identifier of the Webhook. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public getWebhookSigningKeys(webhookId: number, options?: RawAxiosRequestConfig) { + return WebhooksApiFp(this.configuration).getWebhookSigningKeys(webhookId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. + * @summary List Webhooks + * @param {string} productId The identifier of the Product. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public getWebhooks(productId: string, options?: RawAxiosRequestConfig) { + return WebhooksApiFp(this.configuration).getWebhooks(productId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter. **Important:** As this endpoint is doing a complete replace, it\'s important to set every other attribute that you don\'t want to change in its original state. Not listing one means it will reset. + * @summary Replace Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {WebHookRequest} webHookRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public replaceWebhook(webhookId: number, webHookRequest: WebHookRequest, options?: RawAxiosRequestConfig) { + return WebhooksApiFp(this.configuration).replaceWebhook(webhookId, webHookRequest, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don\'t want to change. For example: We have the following resource. ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"null\", \"webHookHeaders\": [] } ``` If we send an update request body as below (it changes the `content` field and adds a new HTTP header): ```json [ { \"op\": \"replace\", \"path\": \"/content\", \"value\": \"Some webhook content.\" }, { \"op\": \"add\", \"path\": \"/webHookHeaders/-\", \"value\": { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\" } } ] ``` Only the `content` and `webHookHeaders` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"Some webhook content.\", \"webHookHeaders\": [ { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\", \"isSecure\": false } ] } ``` + * @summary Update Webhook + * @param {number} webhookId The identifier of the Webhook. + * @param {Array} jsonPatchOperation + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public updateWebhook(webhookId: number, jsonPatchOperation: Array, options?: RawAxiosRequestConfig) { + return WebhooksApiFp(this.configuration).updateWebhook(webhookId, jsonPatchOperation, options).then((request) => request(this.axios, this.basePath)); + } +} + diff --git a/base.ts b/base.ts index ca58c11..136fae0 100644 --- a/base.ts +++ b/base.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -19,7 +19,7 @@ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; -export const BASE_PATH = "https://test-api.configcat.com".replace(/\/+$/, ""); +export const BASE_PATH = "https://api.configcat.com".replace(/\/+$/, ""); /** * diff --git a/common.ts b/common.ts index 2791352..b3b6961 100644 --- a/common.ts +++ b/common.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/configuration.ts b/configuration.ts index 95b1cd1..4388482 100644 --- a/configuration.ts +++ b/configuration.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/index.ts b/index.ts index 0f2c050..2b8390e 100644 --- a/index.ts +++ b/index.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/access-type.ts b/model/access-type.ts index 61cdf3c..53ef1ed 100644 --- a/model/access-type.ts +++ b/model/access-type.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/add-or-update-integration-link-model.ts b/model/add-or-update-integration-link-model.ts index 80f0932..1cd4ed4 100644 --- a/model/add-or-update-integration-link-model.ts +++ b/model/add-or-update-integration-link-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/add-or-update-jira-integration-link-model.ts b/model/add-or-update-jira-integration-link-model.ts index cebf5bb..91bb966 100644 --- a/model/add-or-update-jira-integration-link-model.ts +++ b/model/add-or-update-jira-integration-link-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/audit-log-item-model.ts b/model/audit-log-item-model.ts index 4cc2461..9f4650c 100644 --- a/model/audit-log-item-model.ts +++ b/model/audit-log-item-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/audit-log-type.ts b/model/audit-log-type.ts index cb4eb3c..4c7fccc 100644 --- a/model/audit-log-type.ts +++ b/model/audit-log-type.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/code-reference-model.ts b/model/code-reference-model.ts index 8b438e0..8ed7442 100644 --- a/model/code-reference-model.ts +++ b/model/code-reference-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/code-reference-request.ts b/model/code-reference-request.ts index e671ea2..c920f3a 100644 --- a/model/code-reference-request.ts +++ b/model/code-reference-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/comparison-value-list-model.ts b/model/comparison-value-list-model.ts index 6ade305..4a93b5a 100644 --- a/model/comparison-value-list-model.ts +++ b/model/comparison-value-list-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/comparison-value-model.ts b/model/comparison-value-model.ts index d12dbcd..06224d9 100644 --- a/model/comparison-value-model.ts +++ b/model/comparison-value-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/condition-model.ts b/model/condition-model.ts index a9bd955..e813560 100644 --- a/model/condition-model.ts +++ b/model/condition-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/config-model.ts b/model/config-model.ts index c151d16..d91d36f 100644 --- a/model/config-model.ts +++ b/model/config-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/config-setting-formula-model.ts b/model/config-setting-formula-model.ts index b27a100..56ba38e 100644 --- a/model/config-setting-formula-model.ts +++ b/model/config-setting-formula-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/config-setting-formulas-model.ts b/model/config-setting-formulas-model.ts index bc40ed0..9e5b393 100644 --- a/model/config-setting-formulas-model.ts +++ b/model/config-setting-formulas-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/config-setting-value-model.ts b/model/config-setting-value-model.ts index 4ccf98d..6792e93 100644 --- a/model/config-setting-value-model.ts +++ b/model/config-setting-value-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/config-setting-values-model.ts b/model/config-setting-values-model.ts index d70ffa1..b9bb53f 100644 --- a/model/config-setting-values-model.ts +++ b/model/config-setting-values-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/connect-request.ts b/model/connect-request.ts index 72d2f6a..160d617 100644 --- a/model/connect-request.ts +++ b/model/connect-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/create-config-request.ts b/model/create-config-request.ts index a6aed57..e41e0a4 100644 --- a/model/create-config-request.ts +++ b/model/create-config-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/create-environment-model.ts b/model/create-environment-model.ts index 8a865ee..4aca2fb 100644 --- a/model/create-environment-model.ts +++ b/model/create-environment-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/create-integration-model.ts b/model/create-integration-model.ts new file mode 100644 index 0000000..ee290b1 --- /dev/null +++ b/model/create-integration-model.ts @@ -0,0 +1,59 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { IntegrationType } from './integration-type'; + +/** + * + * @export + * @interface CreateIntegrationModel + */ +export interface CreateIntegrationModel { + /** + * + * @type {IntegrationType} + * @memberof CreateIntegrationModel + */ + 'integrationType': IntegrationType; + /** + * Name of the Integration. + * @type {string} + * @memberof CreateIntegrationModel + */ + 'name': string; + /** + * Parameters of the Integration. + * @type {{ [key: string]: string | null; }} + * @memberof CreateIntegrationModel + */ + 'parameters': { [key: string]: string | null; }; + /** + * List of Environment IDs that are connected with this Integration. If the list is empty, all of the Environments are connected. + * @type {Array} + * @memberof CreateIntegrationModel + */ + 'environmentIds': Array; + /** + * List of Config IDs that are connected with this Integration. If the list is empty, all of the Configs are connected. + * @type {Array} + * @memberof CreateIntegrationModel + */ + 'configIds': Array; +} + + + diff --git a/model/create-or-update-environment-access-model.ts b/model/create-or-update-environment-access-model.ts index af5cfb0..3724a01 100644 --- a/model/create-or-update-environment-access-model.ts +++ b/model/create-or-update-environment-access-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/create-permission-group-request.ts b/model/create-permission-group-request.ts index 3856084..3d5e547 100644 --- a/model/create-permission-group-request.ts +++ b/model/create-permission-group-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/create-product-request.ts b/model/create-product-request.ts index ecbeee9..8a80f1c 100644 --- a/model/create-product-request.ts +++ b/model/create-product-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/create-segment-model.ts b/model/create-segment-model.ts index 639dcdf..67d4415 100644 --- a/model/create-segment-model.ts +++ b/model/create-segment-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/create-setting-initial-values.ts b/model/create-setting-initial-values.ts index 6d4cbe2..ebf1715 100644 --- a/model/create-setting-initial-values.ts +++ b/model/create-setting-initial-values.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/create-tag-model.ts b/model/create-tag-model.ts index 56253b9..19ead60 100644 --- a/model/create-tag-model.ts +++ b/model/create-tag-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/delete-integration-link-model.ts b/model/delete-integration-link-model.ts index 48412dd..40a129c 100644 --- a/model/delete-integration-link-model.ts +++ b/model/delete-integration-link-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/delete-repository-reports-request.ts b/model/delete-repository-reports-request.ts index 341ab99..016b965 100644 --- a/model/delete-repository-reports-request.ts +++ b/model/delete-repository-reports-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/environment-access-model.ts b/model/environment-access-model.ts index f729d3c..6e011c9 100644 --- a/model/environment-access-model.ts +++ b/model/environment-access-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/environment-access-type.ts b/model/environment-access-type.ts index 7b789fb..94e81b4 100644 --- a/model/environment-access-type.ts +++ b/model/environment-access-type.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/environment-model.ts b/model/environment-model.ts index 46d7dd5..69f274e 100644 --- a/model/environment-model.ts +++ b/model/environment-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/evaluation-version.ts b/model/evaluation-version.ts index 053fcda..21c1fb4 100644 --- a/model/evaluation-version.ts +++ b/model/evaluation-version.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/feature-flag-limitations.ts b/model/feature-flag-limitations.ts index 4661817..ba2d995 100644 --- a/model/feature-flag-limitations.ts +++ b/model/feature-flag-limitations.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/flag-reference.ts b/model/flag-reference.ts index 07aee0b..88f4f48 100644 --- a/model/flag-reference.ts +++ b/model/flag-reference.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/index.ts b/model/index.ts index a079bfa..d0b5480 100644 --- a/model/index.ts +++ b/model/index.ts @@ -1,12 +1,10 @@ export * from './access-type'; export * from './add-or-update-integration-link-model'; export * from './add-or-update-jira-integration-link-model'; -export * from './add-user-to-group-request'; export * from './audit-log-item-model'; export * from './audit-log-type'; export * from './code-reference-model'; export * from './code-reference-request'; -export * from './code-references-for-setting-model'; export * from './comparison-value-list-model'; export * from './comparison-value-model'; export * from './condition-model'; @@ -18,6 +16,7 @@ export * from './config-setting-values-model'; export * from './connect-request'; export * from './create-config-request'; export * from './create-environment-model'; +export * from './create-integration-model'; export * from './create-or-update-environment-access-model'; export * from './create-permission-group-request'; export * from './create-product-request'; @@ -37,12 +36,19 @@ export * from './integration-link-detail'; export * from './integration-link-details-model'; export * from './integration-link-model'; export * from './integration-link-type'; +export * from './integration-model'; +export * from './integration-type'; +export * from './integrations-model'; +export * from './invitation-model'; export * from './invite-members-request'; export * from './json-patch-operation'; +export * from './key-generation-mode'; export * from './me-model'; export * from './member-model'; +export * from './modify-integration-request'; export * from './operation-type'; export * from './organization-admin-model'; +export * from './organization-invitation-model'; export * from './organization-member-model'; export * from './organization-members-model'; export * from './organization-model'; @@ -51,11 +57,14 @@ export * from './organization-permission-model'; export * from './organization-product-model'; export * from './percentage-option-model'; export * from './permission-group-model'; +export * from './preferences-model'; export * from './prerequisite-comparator'; export * from './prerequisite-flag-condition-model'; export * from './product-model'; +export * from './reason-required-environment-model'; export * from './reference-line'; export * from './reference-lines'; +export * from './replace-setting-model'; export * from './rollout-percentage-item-model'; export * from './rollout-rule-comparator'; export * from './rollout-rule-model'; @@ -77,8 +86,11 @@ export * from './update-environment-model'; export * from './update-evaluation-formula-model'; export * from './update-evaluation-formula-with-id-model'; export * from './update-evaluation-formulas-model'; +export * from './update-member-permissions-request'; export * from './update-permission-group-request'; +export * from './update-preferences-request'; export * from './update-product-request'; +export * from './update-reason-required-environment-model'; export * from './update-segment-model'; export * from './update-setting-value-model'; export * from './update-setting-value-with-setting-id-model'; @@ -88,3 +100,10 @@ export * from './user-comparator'; export * from './user-condition-model'; export * from './user-model'; export * from './value-model'; +export * from './web-hook-http-method'; +export * from './web-hook-request'; +export * from './webhook-config'; +export * from './webhook-environment'; +export * from './webhook-header-model'; +export * from './webhook-model'; +export * from './webhook-signing-keys-model'; diff --git a/model/initial-value.ts b/model/initial-value.ts index 48146ae..7d6abe4 100644 --- a/model/initial-value.ts +++ b/model/initial-value.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/integration-link-detail.ts b/model/integration-link-detail.ts index 2f54c6b..0675881 100644 --- a/model/integration-link-detail.ts +++ b/model/integration-link-detail.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/integration-link-details-model.ts b/model/integration-link-details-model.ts index b93672c..d936696 100644 --- a/model/integration-link-details-model.ts +++ b/model/integration-link-details-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/integration-link-model.ts b/model/integration-link-model.ts index 2af3f59..76d0781 100644 --- a/model/integration-link-model.ts +++ b/model/integration-link-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/integration-link-type.ts b/model/integration-link-type.ts index 97ac109..b78e259 100644 --- a/model/integration-link-type.ts +++ b/model/integration-link-type.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/integration-model.ts b/model/integration-model.ts new file mode 100644 index 0000000..ff5465e --- /dev/null +++ b/model/integration-model.ts @@ -0,0 +1,74 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { IntegrationType } from './integration-type'; +// May contain unused imports in some cases +// @ts-ignore +import { ProductModel } from './product-model'; + +/** + * Details of the Integration. + * @export + * @interface IntegrationModel + */ +export interface IntegrationModel { + /** + * + * @type {ProductModel} + * @memberof IntegrationModel + */ + 'product'?: ProductModel; + /** + * Identifier of the Integration. + * @type {string} + * @memberof IntegrationModel + */ + 'integrationId'?: string; + /** + * Name of the Integration. + * @type {string} + * @memberof IntegrationModel + */ + 'name'?: string | null; + /** + * + * @type {IntegrationType} + * @memberof IntegrationModel + */ + 'integrationType'?: IntegrationType; + /** + * Parameters of the Integration. + * @type {{ [key: string]: string | null; }} + * @memberof IntegrationModel + */ + 'parameters'?: { [key: string]: string | null; } | null; + /** + * List of Environment IDs that are connected with this Integration. If the list is empty, all of the Environments are connected. + * @type {Array} + * @memberof IntegrationModel + */ + 'environmentIds'?: Array | null; + /** + * List of Config IDs that are connected with this Integration. If the list is empty, all of the Configs are connected. + * @type {Array} + * @memberof IntegrationModel + */ + 'configIds'?: Array | null; +} + + + diff --git a/model/integration-type.ts b/model/integration-type.ts new file mode 100644 index 0000000..f3330fe --- /dev/null +++ b/model/integration-type.ts @@ -0,0 +1,35 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @enum {string} + */ + +export const IntegrationType = { + DataDog: 'dataDog', + Slack: 'slack', + Amplitude: 'amplitude', + MixPanel: 'mixPanel', + Segment: 'segment', + PubNub: 'pubNub' +} as const; + +export type IntegrationType = typeof IntegrationType[keyof typeof IntegrationType]; + + + diff --git a/model/integrations-model.ts b/model/integrations-model.ts new file mode 100644 index 0000000..c257ee4 --- /dev/null +++ b/model/integrations-model.ts @@ -0,0 +1,33 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { IntegrationModel } from './integration-model'; + +/** + * + * @export + * @interface IntegrationsModel + */ +export interface IntegrationsModel { + /** + * The Integrations of the Product. + * @type {Array} + * @memberof IntegrationsModel + */ + 'integrations'?: Array | null; +} + diff --git a/model/invitation-model.ts b/model/invitation-model.ts new file mode 100644 index 0000000..b9a1fb1 --- /dev/null +++ b/model/invitation-model.ts @@ -0,0 +1,54 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface InvitationModel + */ +export interface InvitationModel { + /** + * The identifier of the Invitation. + * @type {string} + * @memberof InvitationModel + */ + 'invitationId'?: string; + /** + * The invited user\'s email address. + * @type {string} + * @memberof InvitationModel + */ + 'email'?: string | null; + /** + * The identifier of the Permission Group the user was invited to. + * @type {number} + * @memberof InvitationModel + */ + 'permissionGroupId'?: number; + /** + * Creation time of the Invitation. + * @type {string} + * @memberof InvitationModel + */ + 'createdAt'?: string; + /** + * Determines whether the Invitation is expired. + * @type {boolean} + * @memberof InvitationModel + */ + 'expired'?: boolean; +} + diff --git a/model/invite-members-request.ts b/model/invite-members-request.ts index 2418273..c2439cd 100644 --- a/model/invite-members-request.ts +++ b/model/invite-members-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/json-patch-operation.ts b/model/json-patch-operation.ts index e59b8fa..6a619e8 100644 --- a/model/json-patch-operation.ts +++ b/model/json-patch-operation.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/key-generation-mode.ts b/model/key-generation-mode.ts new file mode 100644 index 0000000..21d74ec --- /dev/null +++ b/model/key-generation-mode.ts @@ -0,0 +1,34 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * Determines the Feature Flag key generation mode. + * @export + * @enum {string} + */ + +export const KeyGenerationMode = { + CamelCase: 'camelCase', + LowerCase: 'lowerCase', + UpperCase: 'upperCase', + PascalCase: 'pascalCase', + KebabCase: 'kebabCase' +} as const; + +export type KeyGenerationMode = typeof KeyGenerationMode[keyof typeof KeyGenerationMode]; + + + diff --git a/model/me-model.ts b/model/me-model.ts index 5b2119c..ec68560 100644 --- a/model/me-model.ts +++ b/model/me-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/member-model.ts b/model/member-model.ts index 17b54cc..f76becd 100644 --- a/model/member-model.ts +++ b/model/member-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/modify-integration-request.ts b/model/modify-integration-request.ts new file mode 100644 index 0000000..46a1869 --- /dev/null +++ b/model/modify-integration-request.ts @@ -0,0 +1,48 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface ModifyIntegrationRequest + */ +export interface ModifyIntegrationRequest { + /** + * Name of the Integration. + * @type {string} + * @memberof ModifyIntegrationRequest + */ + 'name': string; + /** + * Parameters of the Integration. + * @type {{ [key: string]: string | null; }} + * @memberof ModifyIntegrationRequest + */ + 'parameters': { [key: string]: string | null; }; + /** + * List of Environment IDs that are connected with this Integration. If the list is empty, all of the Environments are connected. + * @type {Array} + * @memberof ModifyIntegrationRequest + */ + 'environmentIds': Array; + /** + * List of Config IDs that are connected with this Integration. If the list is empty, all of the Configs are connected. + * @type {Array} + * @memberof ModifyIntegrationRequest + */ + 'configIds': Array; +} + diff --git a/model/operation-type.ts b/model/operation-type.ts index ba139e4..ddbc241 100644 --- a/model/operation-type.ts +++ b/model/operation-type.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/organization-admin-model.ts b/model/organization-admin-model.ts index 57dd6df..ee85b65 100644 --- a/model/organization-admin-model.ts +++ b/model/organization-admin-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/organization-invitation-model.ts b/model/organization-invitation-model.ts new file mode 100644 index 0000000..2488ad1 --- /dev/null +++ b/model/organization-invitation-model.ts @@ -0,0 +1,72 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface OrganizationInvitationModel + */ +export interface OrganizationInvitationModel { + /** + * The identifier of the Invitation. + * @type {string} + * @memberof OrganizationInvitationModel + */ + 'invitationId'?: string; + /** + * The invited user\'s email address. + * @type {string} + * @memberof OrganizationInvitationModel + */ + 'email'?: string | null; + /** + * The identifier of the Product the user was invited to. + * @type {string} + * @memberof OrganizationInvitationModel + */ + 'productId'?: string; + /** + * The name of the Product the user was invited to. + * @type {string} + * @memberof OrganizationInvitationModel + */ + 'productName'?: string | null; + /** + * The identifier of the Permission Group the user was invited to. + * @type {number} + * @memberof OrganizationInvitationModel + */ + 'permissionGroupId'?: number; + /** + * Creation time of the Invitation. + * @type {string} + * @memberof OrganizationInvitationModel + */ + 'createdAt'?: string; + /** + * Determines whether the Invitation is expired. + * @type {boolean} + * @memberof OrganizationInvitationModel + */ + 'expired'?: boolean; + /** + * Expiration time of the Invitation. + * @type {string} + * @memberof OrganizationInvitationModel + */ + 'expires'?: string; +} + diff --git a/model/organization-member-model.ts b/model/organization-member-model.ts index df6a0f3..7b27403 100644 --- a/model/organization-member-model.ts +++ b/model/organization-member-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/organization-members-model.ts b/model/organization-members-model.ts index 8389fbe..750bc17 100644 --- a/model/organization-members-model.ts +++ b/model/organization-members-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com @@ -32,6 +32,12 @@ export interface OrganizationMembersModel { * @memberof OrganizationMembersModel */ 'admins'?: Array | null; + /** + * List of Billing Managers. + * @type {Array} + * @memberof OrganizationMembersModel + */ + 'billingManagers'?: Array | null; /** * List of Organization Members. * @type {Array} diff --git a/model/organization-model.ts b/model/organization-model.ts index 1a60343..5a7591f 100644 --- a/model/organization-model.ts +++ b/model/organization-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/organization-permission-group-model.ts b/model/organization-permission-group-model.ts index 33c3b72..bcbb170 100644 --- a/model/organization-permission-group-model.ts +++ b/model/organization-permission-group-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/organization-permission-model.ts b/model/organization-permission-model.ts index 0784f96..2bc145d 100644 --- a/model/organization-permission-model.ts +++ b/model/organization-permission-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/organization-product-model.ts b/model/organization-product-model.ts index 107fba8..b153eb9 100644 --- a/model/organization-product-model.ts +++ b/model/organization-product-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/percentage-option-model.ts b/model/percentage-option-model.ts index d7bd487..8b019e3 100644 --- a/model/percentage-option-model.ts +++ b/model/percentage-option-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/permission-group-model.ts b/model/permission-group-model.ts index b26a7a2..c2e0f94 100644 --- a/model/permission-group-model.ts +++ b/model/permission-group-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/preferences-model.ts b/model/preferences-model.ts new file mode 100644 index 0000000..1db2222 --- /dev/null +++ b/model/preferences-model.ts @@ -0,0 +1,62 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { KeyGenerationMode } from './key-generation-mode'; +// May contain unused imports in some cases +// @ts-ignore +import { ReasonRequiredEnvironmentModel } from './reason-required-environment-model'; + +/** + * + * @export + * @interface PreferencesModel + */ +export interface PreferencesModel { + /** + * Indicates that a mandatory note required for saving and publishing. + * @type {boolean} + * @memberof PreferencesModel + */ + 'reasonRequired'?: boolean; + /** + * + * @type {KeyGenerationMode} + * @memberof PreferencesModel + */ + 'keyGenerationMode'?: KeyGenerationMode; + /** + * Indicates whether a variation ID\'s must be shown on the ConfigCat Dashboard. + * @type {boolean} + * @memberof PreferencesModel + */ + 'showVariationId'?: boolean; + /** + * List of Environments where mandatory note must be set before saving and publishing. + * @type {Array} + * @memberof PreferencesModel + */ + 'reasonRequiredEnvironments'?: Array | null; + /** + * Indicates whether Feature flags and Settings must have a hint. + * @type {boolean} + * @memberof PreferencesModel + */ + 'mandatorySettingHint'?: boolean; +} + + + diff --git a/model/prerequisite-comparator.ts b/model/prerequisite-comparator.ts index f175dd1..78fba6b 100644 --- a/model/prerequisite-comparator.ts +++ b/model/prerequisite-comparator.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/prerequisite-flag-condition-model.ts b/model/prerequisite-flag-condition-model.ts index 528b5b1..bcbe1a8 100644 --- a/model/prerequisite-flag-condition-model.ts +++ b/model/prerequisite-flag-condition-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/product-model.ts b/model/product-model.ts index 2b2d089..72f8f9f 100644 --- a/model/product-model.ts +++ b/model/product-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/reason-required-environment-model.ts b/model/reason-required-environment-model.ts new file mode 100644 index 0000000..d6e059d --- /dev/null +++ b/model/reason-required-environment-model.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface ReasonRequiredEnvironmentModel + */ +export interface ReasonRequiredEnvironmentModel { + /** + * Identifier of the Environment. + * @type {string} + * @memberof ReasonRequiredEnvironmentModel + */ + 'environmentId'?: string; + /** + * Indicates that a mandatory note is required in this Environment for saving and publishing. + * @type {boolean} + * @memberof ReasonRequiredEnvironmentModel + */ + 'reasonRequired'?: boolean; + /** + * Name of the Environment. + * @type {string} + * @memberof ReasonRequiredEnvironmentModel + */ + 'environmentName'?: string | null; +} + diff --git a/model/reference-line.ts b/model/reference-line.ts index 01f2e8c..a49d154 100644 --- a/model/reference-line.ts +++ b/model/reference-line.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/reference-lines.ts b/model/reference-lines.ts index 68a3856..88759bb 100644 --- a/model/reference-lines.ts +++ b/model/reference-lines.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/replace-setting-model.ts b/model/replace-setting-model.ts new file mode 100644 index 0000000..80959dd --- /dev/null +++ b/model/replace-setting-model.ts @@ -0,0 +1,48 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface ReplaceSettingModel + */ +export interface ReplaceSettingModel { + /** + * A short description for the setting, shown on the Dashboard UI. + * @type {string} + * @memberof ReplaceSettingModel + */ + 'hint'?: string | null; + /** + * The IDs of the tags which are attached to the setting. + * @type {Array} + * @memberof ReplaceSettingModel + */ + 'tags'?: Array | null; + /** + * The order of the Setting represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers. + * @type {number} + * @memberof ReplaceSettingModel + */ + 'order'?: number | null; + /** + * The name of the Feature Flag or Setting. + * @type {string} + * @memberof ReplaceSettingModel + */ + 'name': string; +} + diff --git a/model/rollout-percentage-item-model.ts b/model/rollout-percentage-item-model.ts index e1db2dc..361b3d4 100644 --- a/model/rollout-percentage-item-model.ts +++ b/model/rollout-percentage-item-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/rollout-rule-comparator.ts b/model/rollout-rule-comparator.ts index 561669a..d4019ef 100644 --- a/model/rollout-rule-comparator.ts +++ b/model/rollout-rule-comparator.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/rollout-rule-model.ts b/model/rollout-rule-model.ts index 4624107..da3c45c 100644 --- a/model/rollout-rule-model.ts +++ b/model/rollout-rule-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/sdk-keys-model.ts b/model/sdk-keys-model.ts index 6f13140..47283f3 100644 --- a/model/sdk-keys-model.ts +++ b/model/sdk-keys-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/segment-comparator.ts b/model/segment-comparator.ts index c753b60..209eb5a 100644 --- a/model/segment-comparator.ts +++ b/model/segment-comparator.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/segment-condition-model.ts b/model/segment-condition-model.ts index 538a24a..d614864 100644 --- a/model/segment-condition-model.ts +++ b/model/segment-condition-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/segment-list-model.ts b/model/segment-list-model.ts index 64ea484..aa7126f 100644 --- a/model/segment-list-model.ts +++ b/model/segment-list-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/segment-model.ts b/model/segment-model.ts index e099927..994a56e 100644 --- a/model/segment-model.ts +++ b/model/segment-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/setting-data-model.ts b/model/setting-data-model.ts index 4b860f6..b369e88 100644 --- a/model/setting-data-model.ts +++ b/model/setting-data-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/setting-formula-model.ts b/model/setting-formula-model.ts index 8efb22d..cd55db0 100644 --- a/model/setting-formula-model.ts +++ b/model/setting-formula-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/setting-model.ts b/model/setting-model.ts index 2b29d3e..d48342e 100644 --- a/model/setting-model.ts +++ b/model/setting-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/setting-tag-model.ts b/model/setting-tag-model.ts index 1ab28b6..8514ef3 100644 --- a/model/setting-tag-model.ts +++ b/model/setting-tag-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/setting-type.ts b/model/setting-type.ts index caa494c..85c22db 100644 --- a/model/setting-type.ts +++ b/model/setting-type.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/setting-value-model.ts b/model/setting-value-model.ts index a93e04c..b7211a9 100644 --- a/model/setting-value-model.ts +++ b/model/setting-value-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/tag-model.ts b/model/tag-model.ts index 4788686..1221006 100644 --- a/model/tag-model.ts +++ b/model/tag-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/targeting-rule-model.ts b/model/targeting-rule-model.ts index b7fc5e8..bec648a 100644 --- a/model/targeting-rule-model.ts +++ b/model/targeting-rule-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-config-request.ts b/model/update-config-request.ts index 774b0d1..99db873 100644 --- a/model/update-config-request.ts +++ b/model/update-config-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-environment-model.ts b/model/update-environment-model.ts index c737de4..dccddfc 100644 --- a/model/update-environment-model.ts +++ b/model/update-environment-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-evaluation-formula-model.ts b/model/update-evaluation-formula-model.ts index 6929084..aadea64 100644 --- a/model/update-evaluation-formula-model.ts +++ b/model/update-evaluation-formula-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-evaluation-formula-with-id-model.ts b/model/update-evaluation-formula-with-id-model.ts index 4bf0539..6be250c 100644 --- a/model/update-evaluation-formula-with-id-model.ts +++ b/model/update-evaluation-formula-with-id-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-evaluation-formulas-model.ts b/model/update-evaluation-formulas-model.ts index 6250f44..7490462 100644 --- a/model/update-evaluation-formulas-model.ts +++ b/model/update-evaluation-formulas-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-member-permissions-request.ts b/model/update-member-permissions-request.ts new file mode 100644 index 0000000..f341114 --- /dev/null +++ b/model/update-member-permissions-request.ts @@ -0,0 +1,48 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface UpdateMemberPermissionsRequest + */ +export interface UpdateMemberPermissionsRequest { + /** + * List of Permission Group identifiers to where the Member should be added. + * @type {Array} + * @memberof UpdateMemberPermissionsRequest + */ + 'permissionGroupIds'?: Array | null; + /** + * Indicates that the member must be Organization Admin. + * @type {boolean} + * @memberof UpdateMemberPermissionsRequest + */ + 'isAdmin'?: boolean | null; + /** + * Indicates that the member must be Billing Manager. + * @type {boolean} + * @memberof UpdateMemberPermissionsRequest + */ + 'isBillingManager'?: boolean | null; + /** + * When `true`, the member will be removed from those Permission Groups that are not listed in the `permissionGroupIds` field. + * @type {boolean} + * @memberof UpdateMemberPermissionsRequest + */ + 'removeFromPermissionGroupsWhereIdNotSet'?: boolean; +} + diff --git a/model/update-permission-group-request.ts b/model/update-permission-group-request.ts index bf84556..99caab8 100644 --- a/model/update-permission-group-request.ts +++ b/model/update-permission-group-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-preferences-request.ts b/model/update-preferences-request.ts new file mode 100644 index 0000000..f8c2d15 --- /dev/null +++ b/model/update-preferences-request.ts @@ -0,0 +1,62 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { KeyGenerationMode } from './key-generation-mode'; +// May contain unused imports in some cases +// @ts-ignore +import { UpdateReasonRequiredEnvironmentModel } from './update-reason-required-environment-model'; + +/** + * + * @export + * @interface UpdatePreferencesRequest + */ +export interface UpdatePreferencesRequest { + /** + * Indicates that a mandatory note is required for saving and publishing. + * @type {boolean} + * @memberof UpdatePreferencesRequest + */ + 'reasonRequired'?: boolean | null; + /** + * + * @type {KeyGenerationMode} + * @memberof UpdatePreferencesRequest + */ + 'keyGenerationMode'?: KeyGenerationMode; + /** + * Indicates whether a variation ID\'s must be shown on the ConfigCat Dashboard. + * @type {boolean} + * @memberof UpdatePreferencesRequest + */ + 'showVariationId'?: boolean | null; + /** + * Indicates whether Feature flags and Settings must have a hint. + * @type {boolean} + * @memberof UpdatePreferencesRequest + */ + 'mandatorySettingHint'?: boolean | null; + /** + * List of Environments where mandatory note must be set before saving and publishing. + * @type {Array} + * @memberof UpdatePreferencesRequest + */ + 'reasonRequiredEnvironments'?: Array | null; +} + + + diff --git a/model/update-product-request.ts b/model/update-product-request.ts index a915ef7..00153a4 100644 --- a/model/update-product-request.ts +++ b/model/update-product-request.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-reason-required-environment-model.ts b/model/update-reason-required-environment-model.ts new file mode 100644 index 0000000..b938c19 --- /dev/null +++ b/model/update-reason-required-environment-model.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface UpdateReasonRequiredEnvironmentModel + */ +export interface UpdateReasonRequiredEnvironmentModel { + /** + * Identifier of the Environment. + * @type {string} + * @memberof UpdateReasonRequiredEnvironmentModel + */ + 'environmentId'?: string; + /** + * Indicates that a mandatory note is required in this Environment for saving and publishing. + * @type {boolean} + * @memberof UpdateReasonRequiredEnvironmentModel + */ + 'reasonRequired'?: boolean; +} + diff --git a/model/update-segment-model.ts b/model/update-segment-model.ts index 862199b..cf63fa0 100644 --- a/model/update-segment-model.ts +++ b/model/update-segment-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-setting-value-model.ts b/model/update-setting-value-model.ts index 4da8599..44a16a7 100644 --- a/model/update-setting-value-model.ts +++ b/model/update-setting-value-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-setting-value-with-setting-id-model.ts b/model/update-setting-value-with-setting-id-model.ts index 6522cf2..ce11ec7 100644 --- a/model/update-setting-value-with-setting-id-model.ts +++ b/model/update-setting-value-with-setting-id-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-setting-values-with-id-model.ts b/model/update-setting-values-with-id-model.ts index df54219..5c34938 100644 --- a/model/update-setting-values-with-id-model.ts +++ b/model/update-setting-values-with-id-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/update-tag-model.ts b/model/update-tag-model.ts index 1300217..78d5f40 100644 --- a/model/update-tag-model.ts +++ b/model/update-tag-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/user-comparator.ts b/model/user-comparator.ts index faef97b..8b05980 100644 --- a/model/user-comparator.ts +++ b/model/user-comparator.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/user-condition-model.ts b/model/user-condition-model.ts index 188f767..1325bea 100644 --- a/model/user-condition-model.ts +++ b/model/user-condition-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/user-model.ts b/model/user-model.ts index c63fecf..30ee4bd 100644 --- a/model/user-model.ts +++ b/model/user-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/value-model.ts b/model/value-model.ts index a59d6f4..8ec05f3 100644 --- a/model/value-model.ts +++ b/model/value-model.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * ConfigCat Public Management API - * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * The version of the OpenAPI document: v1 * Contact: support@configcat.com diff --git a/model/web-hook-http-method.ts b/model/web-hook-http-method.ts new file mode 100644 index 0000000..3e061f6 --- /dev/null +++ b/model/web-hook-http-method.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @enum {string} + */ + +export const WebHookHttpMethod = { + Get: 'get', + Post: 'post' +} as const; + +export type WebHookHttpMethod = typeof WebHookHttpMethod[keyof typeof WebHookHttpMethod]; + + + diff --git a/model/web-hook-request.ts b/model/web-hook-request.ts new file mode 100644 index 0000000..f029945 --- /dev/null +++ b/model/web-hook-request.ts @@ -0,0 +1,56 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { WebHookHttpMethod } from './web-hook-http-method'; +// May contain unused imports in some cases +// @ts-ignore +import { WebhookHeaderModel } from './webhook-header-model'; + +/** + * + * @export + * @interface WebHookRequest + */ +export interface WebHookRequest { + /** + * The URL of the Webhook. + * @type {string} + * @memberof WebHookRequest + */ + 'url': string; + /** + * The HTTP body content. + * @type {string} + * @memberof WebHookRequest + */ + 'content'?: string | null; + /** + * + * @type {WebHookHttpMethod} + * @memberof WebHookRequest + */ + 'httpMethod'?: WebHookHttpMethod; + /** + * List of HTTP headers. + * @type {Array} + * @memberof WebHookRequest + */ + 'webHookHeaders'?: Array | null; +} + + + diff --git a/model/webhook-config.ts b/model/webhook-config.ts new file mode 100644 index 0000000..29da297 --- /dev/null +++ b/model/webhook-config.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * The Config where the applied changes will invoke the Webhook. + * @export + * @interface WebhookConfig + */ +export interface WebhookConfig { + /** + * The Config\'s name. + * @type {string} + * @memberof WebhookConfig + */ + 'name'?: string | null; + /** + * The Config\'s identifier. + * @type {string} + * @memberof WebhookConfig + */ + 'configId'?: string; +} + diff --git a/model/webhook-environment.ts b/model/webhook-environment.ts new file mode 100644 index 0000000..456bc33 --- /dev/null +++ b/model/webhook-environment.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * The Environment where the applied changes will invoke the Webhook. + * @export + * @interface WebhookEnvironment + */ +export interface WebhookEnvironment { + /** + * The Environment\'s name. + * @type {string} + * @memberof WebhookEnvironment + */ + 'name'?: string | null; + /** + * The Environment\'s identifier. + * @type {string} + * @memberof WebhookEnvironment + */ + 'environmentId'?: string; +} + diff --git a/model/webhook-header-model.ts b/model/webhook-header-model.ts new file mode 100644 index 0000000..829c410 --- /dev/null +++ b/model/webhook-header-model.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface WebhookHeaderModel + */ +export interface WebhookHeaderModel { + /** + * The HTTP header key. + * @type {string} + * @memberof WebhookHeaderModel + */ + 'key': string; + /** + * The HTTP header value. + * @type {string} + * @memberof WebhookHeaderModel + */ + 'value': string; + /** + * Indicates whether the header value is sensitive. + * @type {boolean} + * @memberof WebhookHeaderModel + */ + 'isSecure'?: boolean; +} + diff --git a/model/webhook-model.ts b/model/webhook-model.ts new file mode 100644 index 0000000..b9ede12 --- /dev/null +++ b/model/webhook-model.ts @@ -0,0 +1,80 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { WebHookHttpMethod } from './web-hook-http-method'; +// May contain unused imports in some cases +// @ts-ignore +import { WebhookConfig } from './webhook-config'; +// May contain unused imports in some cases +// @ts-ignore +import { WebhookEnvironment } from './webhook-environment'; +// May contain unused imports in some cases +// @ts-ignore +import { WebhookHeaderModel } from './webhook-header-model'; + +/** + * + * @export + * @interface WebhookModel + */ +export interface WebhookModel { + /** + * The identifier of the Webhook. + * @type {number} + * @memberof WebhookModel + */ + 'webhookId'?: number; + /** + * The URL of the Webhook. + * @type {string} + * @memberof WebhookModel + */ + 'url'?: string | null; + /** + * + * @type {WebHookHttpMethod} + * @memberof WebhookModel + */ + 'httpMethod'?: WebHookHttpMethod; + /** + * The HTTP body content. + * @type {string} + * @memberof WebhookModel + */ + 'content'?: string | null; + /** + * List of HTTP headers that the Webhook must send. + * @type {Array} + * @memberof WebhookModel + */ + 'webHookHeaders'?: Array | null; + /** + * + * @type {WebhookConfig} + * @memberof WebhookModel + */ + 'config'?: WebhookConfig; + /** + * + * @type {WebhookEnvironment} + * @memberof WebhookModel + */ + 'environment'?: WebhookEnvironment; +} + + + diff --git a/model/webhook-signing-keys-model.ts b/model/webhook-signing-keys-model.ts new file mode 100644 index 0000000..f217ccd --- /dev/null +++ b/model/webhook-signing-keys-model.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ConfigCat Public Management API + * The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. + * + * The version of the OpenAPI document: v1 + * Contact: support@configcat.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * + * @export + * @interface WebhookSigningKeysModel + */ +export interface WebhookSigningKeysModel { + /** + * The first signing key. + * @type {string} + * @memberof WebhookSigningKeysModel + */ + 'key1'?: string | null; + /** + * The second signing key. + * @type {string} + * @memberof WebhookSigningKeysModel + */ + 'key2'?: string | null; +} + diff --git a/regenerate.md b/regenerate.md index 585c699..4d2c017 100644 --- a/regenerate.md +++ b/regenerate.md @@ -1,5 +1,5 @@ 1. Regenerate public api Linux: -```docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v7.3.0 generate -i https://test-api.configcat.com/docs/v1/swagger.json -g typescript-axios -o /local --additional-properties=withSeparateModelsAndApi=true --additional-properties=apiPackage=api --additional-properties=modelPackage=model``` +```docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v7.3.0 generate -i https://api.configcat.com/docs/v1/swagger.json -g typescript-axios -o /local --additional-properties=withSeparateModelsAndApi=true --additional-properties=apiPackage=api --additional-properties=modelPackage=model``` Windows: -```docker run --rm -v %CD%:/local openapitools/openapi-generator-cli:v7.3.0 generate -i https://test-api.configcat.com/docs/v1/swagger.json -g typescript-axios -o /local --additional-properties=withSeparateModelsAndApi=true --additional-properties=apiPackage=api --additional-properties=modelPackage=model``` +```docker run --rm -v %CD%:/local openapitools/openapi-generator-cli:v7.3.0 generate -i https://api.configcat.com/docs/v1/swagger.json -g typescript-axios -o /local --additional-properties=withSeparateModelsAndApi=true --additional-properties=apiPackage=api --additional-properties=modelPackage=model``` From 46e4d9b656b0ab21b92c1d01a698ba1cc47ee0b7 Mon Sep 17 00:00:00 2001 From: Lajos Szoke Date: Mon, 9 Sep 2024 16:32:37 +0200 Subject: [PATCH 2/2] regen --- .openapi-generator/FILES | 14 -- api/audit-logs-api.ts | 200 ++++++++++++++++-- api/integration-links-api.ts | 77 ++++--- model/audit-log-item-model.ts | 88 +++++++- model/config-model.ts | 15 +- model/create-config-request.ts | 15 +- model/create-integration-model.ts | 19 +- ...eate-or-update-environment-access-model.ts | 16 +- model/create-permission-group-request.ts | 32 +-- model/create-segment-model.ts | 29 ++- model/create-setting-initial-values.ts | 17 +- model/environment-access-model.ts | 16 +- model/index.ts | 14 -- model/integration-link-model.ts | 14 +- model/integration-model.ts | 19 +- model/json-patch-operation.ts | 20 +- model/permission-group-model.ts | 32 +-- model/preferences-model.ts | 18 +- model/prerequisite-flag-condition-model.ts | 15 +- model/rollout-rule-model.ts | 44 +++- model/segment-condition-model.ts | 15 +- model/segment-model.ts | 31 ++- model/setting-data-model.ts | 17 +- model/setting-model.ts | 17 +- model/update-permission-group-request.ts | 28 ++- model/update-preferences-request.ts | 18 +- model/update-segment-model.ts | 29 ++- model/user-condition-model.ts | 49 ++++- model/web-hook-request.ts | 15 +- model/webhook-model.ts | 15 +- 30 files changed, 703 insertions(+), 245 deletions(-) diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index e9539da..537e87a 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -26,11 +26,9 @@ common.ts configuration.ts git_push.sh index.ts -model/access-type.ts model/add-or-update-integration-link-model.ts model/add-or-update-jira-integration-link-model.ts model/audit-log-item-model.ts -model/audit-log-type.ts model/code-reference-model.ts model/code-reference-request.ts model/comparison-value-list-model.ts @@ -54,9 +52,7 @@ model/create-tag-model.ts model/delete-integration-link-model.ts model/delete-repository-reports-request.ts model/environment-access-model.ts -model/environment-access-type.ts model/environment-model.ts -model/evaluation-version.ts model/feature-flag-limitations.ts model/flag-reference.ts model/index.ts @@ -64,18 +60,14 @@ model/initial-value.ts model/integration-link-detail.ts model/integration-link-details-model.ts model/integration-link-model.ts -model/integration-link-type.ts model/integration-model.ts -model/integration-type.ts model/integrations-model.ts model/invitation-model.ts model/invite-members-request.ts model/json-patch-operation.ts -model/key-generation-mode.ts model/me-model.ts model/member-model.ts model/modify-integration-request.ts -model/operation-type.ts model/organization-admin-model.ts model/organization-invitation-model.ts model/organization-member-model.ts @@ -87,7 +79,6 @@ model/organization-product-model.ts model/percentage-option-model.ts model/permission-group-model.ts model/preferences-model.ts -model/prerequisite-comparator.ts model/prerequisite-flag-condition-model.ts model/product-model.ts model/reason-required-environment-model.ts @@ -95,10 +86,8 @@ model/reference-line.ts model/reference-lines.ts model/replace-setting-model.ts model/rollout-percentage-item-model.ts -model/rollout-rule-comparator.ts model/rollout-rule-model.ts model/sdk-keys-model.ts -model/segment-comparator.ts model/segment-condition-model.ts model/segment-list-model.ts model/segment-model.ts @@ -106,7 +95,6 @@ model/setting-data-model.ts model/setting-formula-model.ts model/setting-model.ts model/setting-tag-model.ts -model/setting-type.ts model/setting-value-model.ts model/tag-model.ts model/targeting-rule-model.ts @@ -125,11 +113,9 @@ model/update-setting-value-model.ts model/update-setting-value-with-setting-id-model.ts model/update-setting-values-with-id-model.ts model/update-tag-model.ts -model/user-comparator.ts model/user-condition-model.ts model/user-model.ts model/value-model.ts -model/web-hook-http-method.ts model/web-hook-request.ts model/webhook-config.ts model/webhook-environment.ts diff --git a/api/audit-logs-api.ts b/api/audit-logs-api.ts index d417d4a..4398e46 100644 --- a/api/audit-logs-api.ts +++ b/api/audit-logs-api.ts @@ -24,8 +24,6 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, ope // @ts-ignore import { AuditLogItemModel } from '../model'; // @ts-ignore -import { AuditLogType } from '../model'; -// @ts-ignore import { SettingModel } from '../model'; /** * AuditLogsApi - axios parameter creator @@ -39,13 +37,13 @@ export const AuditLogsApiAxiosParamCreator = function (configuration?: Configura * @param {string} productId The identifier of the Product. * @param {string} [configId] The identifier of the Config. * @param {string} [environmentId] The identifier of the Environment. - * @param {AuditLogType | null} [auditLogType] Filter Audit logs by Audit log type. + * @param {GetAuditlogsAuditLogTypeEnum} [auditLogType] Filter Audit logs by Audit log type. * @param {string} [fromUtcDateTime] Filter Audit logs by starting UTC date. * @param {string} [toUtcDateTime] Filter Audit logs by ending UTC date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAuditlogs: async (productId: string, configId?: string, environmentId?: string, auditLogType?: AuditLogType | null, fromUtcDateTime?: string, toUtcDateTime?: string, options: RawAxiosRequestConfig = {}): Promise => { + getAuditlogs: async (productId: string, configId?: string, environmentId?: string, auditLogType?: GetAuditlogsAuditLogTypeEnum, fromUtcDateTime?: string, toUtcDateTime?: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'productId' is not null or undefined assertParamExists('getAuditlogs', 'productId', productId) const localVarPath = `/v1/products/{productId}/auditlogs` @@ -145,13 +143,13 @@ export const AuditLogsApiAxiosParamCreator = function (configuration?: Configura * @param {string} [productId] The identifier of the Product. * @param {string} [configId] The identifier of the Config. * @param {string} [environmentId] The identifier of the Environment. - * @param {AuditLogType | null} [auditLogType] Filter Audit logs by Audit log type. + * @param {GetOrganizationAuditlogsAuditLogTypeEnum} [auditLogType] Filter Audit logs by Audit log type. * @param {string} [fromUtcDateTime] Filter Audit logs by starting UTC date. * @param {string} [toUtcDateTime] Filter Audit logs by ending UTC date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOrganizationAuditlogs: async (organizationId: string, productId?: string, configId?: string, environmentId?: string, auditLogType?: AuditLogType | null, fromUtcDateTime?: string, toUtcDateTime?: string, options: RawAxiosRequestConfig = {}): Promise => { + getOrganizationAuditlogs: async (organizationId: string, productId?: string, configId?: string, environmentId?: string, auditLogType?: GetOrganizationAuditlogsAuditLogTypeEnum, fromUtcDateTime?: string, toUtcDateTime?: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'organizationId' is not null or undefined assertParamExists('getOrganizationAuditlogs', 'organizationId', organizationId) const localVarPath = `/v1/organizations/{organizationId}/auditlogs` @@ -226,13 +224,13 @@ export const AuditLogsApiFp = function(configuration?: Configuration) { * @param {string} productId The identifier of the Product. * @param {string} [configId] The identifier of the Config. * @param {string} [environmentId] The identifier of the Environment. - * @param {AuditLogType | null} [auditLogType] Filter Audit logs by Audit log type. + * @param {GetAuditlogsAuditLogTypeEnum} [auditLogType] Filter Audit logs by Audit log type. * @param {string} [fromUtcDateTime] Filter Audit logs by starting UTC date. * @param {string} [toUtcDateTime] Filter Audit logs by ending UTC date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAuditlogs(productId: string, configId?: string, environmentId?: string, auditLogType?: AuditLogType | null, fromUtcDateTime?: string, toUtcDateTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async getAuditlogs(productId: string, configId?: string, environmentId?: string, auditLogType?: GetAuditlogsAuditLogTypeEnum, fromUtcDateTime?: string, toUtcDateTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getAuditlogs(productId, configId, environmentId, auditLogType, fromUtcDateTime, toUtcDateTime, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AuditLogsApi.getAuditlogs']?.[localVarOperationServerIndex]?.url; @@ -258,13 +256,13 @@ export const AuditLogsApiFp = function(configuration?: Configuration) { * @param {string} [productId] The identifier of the Product. * @param {string} [configId] The identifier of the Config. * @param {string} [environmentId] The identifier of the Environment. - * @param {AuditLogType | null} [auditLogType] Filter Audit logs by Audit log type. + * @param {GetOrganizationAuditlogsAuditLogTypeEnum} [auditLogType] Filter Audit logs by Audit log type. * @param {string} [fromUtcDateTime] Filter Audit logs by starting UTC date. * @param {string} [toUtcDateTime] Filter Audit logs by ending UTC date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getOrganizationAuditlogs(organizationId: string, productId?: string, configId?: string, environmentId?: string, auditLogType?: AuditLogType | null, fromUtcDateTime?: string, toUtcDateTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async getOrganizationAuditlogs(organizationId: string, productId?: string, configId?: string, environmentId?: string, auditLogType?: GetOrganizationAuditlogsAuditLogTypeEnum, fromUtcDateTime?: string, toUtcDateTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationAuditlogs(organizationId, productId, configId, environmentId, auditLogType, fromUtcDateTime, toUtcDateTime, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AuditLogsApi.getOrganizationAuditlogs']?.[localVarOperationServerIndex]?.url; @@ -286,13 +284,13 @@ export const AuditLogsApiFactory = function (configuration?: Configuration, base * @param {string} productId The identifier of the Product. * @param {string} [configId] The identifier of the Config. * @param {string} [environmentId] The identifier of the Environment. - * @param {AuditLogType | null} [auditLogType] Filter Audit logs by Audit log type. + * @param {GetAuditlogsAuditLogTypeEnum} [auditLogType] Filter Audit logs by Audit log type. * @param {string} [fromUtcDateTime] Filter Audit logs by starting UTC date. * @param {string} [toUtcDateTime] Filter Audit logs by ending UTC date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAuditlogs(productId: string, configId?: string, environmentId?: string, auditLogType?: AuditLogType | null, fromUtcDateTime?: string, toUtcDateTime?: string, options?: any): AxiosPromise> { + getAuditlogs(productId: string, configId?: string, environmentId?: string, auditLogType?: GetAuditlogsAuditLogTypeEnum, fromUtcDateTime?: string, toUtcDateTime?: string, options?: any): AxiosPromise> { return localVarFp.getAuditlogs(productId, configId, environmentId, auditLogType, fromUtcDateTime, toUtcDateTime, options).then((request) => request(axios, basePath)); }, /** @@ -312,13 +310,13 @@ export const AuditLogsApiFactory = function (configuration?: Configuration, base * @param {string} [productId] The identifier of the Product. * @param {string} [configId] The identifier of the Config. * @param {string} [environmentId] The identifier of the Environment. - * @param {AuditLogType | null} [auditLogType] Filter Audit logs by Audit log type. + * @param {GetOrganizationAuditlogsAuditLogTypeEnum} [auditLogType] Filter Audit logs by Audit log type. * @param {string} [fromUtcDateTime] Filter Audit logs by starting UTC date. * @param {string} [toUtcDateTime] Filter Audit logs by ending UTC date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOrganizationAuditlogs(organizationId: string, productId?: string, configId?: string, environmentId?: string, auditLogType?: AuditLogType | null, fromUtcDateTime?: string, toUtcDateTime?: string, options?: any): AxiosPromise> { + getOrganizationAuditlogs(organizationId: string, productId?: string, configId?: string, environmentId?: string, auditLogType?: GetOrganizationAuditlogsAuditLogTypeEnum, fromUtcDateTime?: string, toUtcDateTime?: string, options?: any): AxiosPromise> { return localVarFp.getOrganizationAuditlogs(organizationId, productId, configId, environmentId, auditLogType, fromUtcDateTime, toUtcDateTime, options).then((request) => request(axios, basePath)); }, }; @@ -337,14 +335,14 @@ export class AuditLogsApi extends BaseAPI { * @param {string} productId The identifier of the Product. * @param {string} [configId] The identifier of the Config. * @param {string} [environmentId] The identifier of the Environment. - * @param {AuditLogType | null} [auditLogType] Filter Audit logs by Audit log type. + * @param {GetAuditlogsAuditLogTypeEnum} [auditLogType] Filter Audit logs by Audit log type. * @param {string} [fromUtcDateTime] Filter Audit logs by starting UTC date. * @param {string} [toUtcDateTime] Filter Audit logs by ending UTC date. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditLogsApi */ - public getAuditlogs(productId: string, configId?: string, environmentId?: string, auditLogType?: AuditLogType | null, fromUtcDateTime?: string, toUtcDateTime?: string, options?: RawAxiosRequestConfig) { + public getAuditlogs(productId: string, configId?: string, environmentId?: string, auditLogType?: GetAuditlogsAuditLogTypeEnum, fromUtcDateTime?: string, toUtcDateTime?: string, options?: RawAxiosRequestConfig) { return AuditLogsApiFp(this.configuration).getAuditlogs(productId, configId, environmentId, auditLogType, fromUtcDateTime, toUtcDateTime, options).then((request) => request(this.axios, this.basePath)); } @@ -367,15 +365,181 @@ export class AuditLogsApi extends BaseAPI { * @param {string} [productId] The identifier of the Product. * @param {string} [configId] The identifier of the Config. * @param {string} [environmentId] The identifier of the Environment. - * @param {AuditLogType | null} [auditLogType] Filter Audit logs by Audit log type. + * @param {GetOrganizationAuditlogsAuditLogTypeEnum} [auditLogType] Filter Audit logs by Audit log type. * @param {string} [fromUtcDateTime] Filter Audit logs by starting UTC date. * @param {string} [toUtcDateTime] Filter Audit logs by ending UTC date. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditLogsApi */ - public getOrganizationAuditlogs(organizationId: string, productId?: string, configId?: string, environmentId?: string, auditLogType?: AuditLogType | null, fromUtcDateTime?: string, toUtcDateTime?: string, options?: RawAxiosRequestConfig) { + public getOrganizationAuditlogs(organizationId: string, productId?: string, configId?: string, environmentId?: string, auditLogType?: GetOrganizationAuditlogsAuditLogTypeEnum, fromUtcDateTime?: string, toUtcDateTime?: string, options?: RawAxiosRequestConfig) { return AuditLogsApiFp(this.configuration).getOrganizationAuditlogs(organizationId, productId, configId, environmentId, auditLogType, fromUtcDateTime, toUtcDateTime, options).then((request) => request(this.axios, this.basePath)); } } +/** + * @export + */ +export const GetAuditlogsAuditLogTypeEnum = { + ProductCreated: 'productCreated', + ProductChanged: 'productChanged', + ProductOwnershipTransferred: 'productOwnershipTransferred', + ProductDeleted: 'productDeleted', + ProductsReordered: 'productsReordered', + TeamMemberInvited: 'teamMemberInvited', + TeamMemberInvitationRevoked: 'teamMemberInvitationRevoked', + TeamMemberJoined: 'teamMemberJoined', + TeamMemberPermissionGroupChanged: 'teamMemberPermissionGroupChanged', + TeamMemberRemoved: 'teamMemberRemoved', + TeamMemberLeft: 'teamMemberLeft', + TeamMemberInvitationChanged: 'teamMemberInvitationChanged', + TeamMemberInvitationResent: 'teamMemberInvitationResent', + TeamMemberInvitationRejected: 'teamMemberInvitationRejected', + ConfigCreated: 'configCreated', + ConfigChanged: 'configChanged', + ConfigDeleted: 'configDeleted', + ConfigsReordered: 'configsReordered', + EnvironmentCreated: 'environmentCreated', + EnvironmentChanged: 'environmentChanged', + EnvironmentDeleted: 'environmentDeleted', + EnvironmentsReordered: 'environmentsReordered', + SettingCreated: 'settingCreated', + SettingChanged: 'settingChanged', + SettingDeleted: 'settingDeleted', + SettingsReordered: 'settingsReordered', + SettingValueChanged: 'settingValueChanged', + WebHookCreated: 'webHookCreated', + WebHookChanged: 'webHookChanged', + WebHookDeleted: 'webHookDeleted', + PermissionGroupCreated: 'permissionGroupCreated', + PermissionGroupChanged: 'permissionGroupChanged', + PermissionGroupDeleted: 'permissionGroupDeleted', + PermissionGroupDefault: 'permissionGroupDefault', + ApiKeyAdded: 'apiKeyAdded', + ApiKeyRemoved: 'apiKeyRemoved', + IntegrationAdded: 'integrationAdded', + IntegrationChanged: 'integrationChanged', + IntegrationRemoved: 'integrationRemoved', + ApiKeyConnected: 'apiKeyConnected', + IntegrationLinkAdded: 'integrationLinkAdded', + IntegrationLinkRemoved: 'integrationLinkRemoved', + OrganizationAdded: 'organizationAdded', + OrganizationRemoved: 'organizationRemoved', + OrganizationChanged: 'organizationChanged', + OrganizationSubscriptionTypeChanged: 'organizationSubscriptionTypeChanged', + OrganizationAdminChanged: 'organizationAdminChanged', + OrganizationAdminLeft: 'organizationAdminLeft', + OrganizationAdminDisabled2Fa: 'organizationAdminDisabled2FA', + TagAdded: 'tagAdded', + TagChanged: 'tagChanged', + TagRemoved: 'tagRemoved', + SettingTagAdded: 'settingTagAdded', + SettingTagRemoved: 'settingTagRemoved', + PublicApiAccessTokenAdded: 'publicApiAccessTokenAdded', + PublicApiAccessTokenRemoved: 'publicApiAccessTokenRemoved', + DomainAdded: 'domainAdded', + DomainVerified: 'domainVerified', + DomainRemoved: 'domainRemoved', + DomainSamlConfigured: 'domainSamlConfigured', + DomainSamlDeleted: 'domainSamlDeleted', + AutoProvisioningConfigurationChanged: 'autoProvisioningConfigurationChanged', + SamlIdpConfigurationAdded: 'samlIdpConfigurationAdded', + SamlIdpConfigurationRemoved: 'samlIdpConfigurationRemoved', + SamlIdpConfigurationUpdated: 'samlIdpConfigurationUpdated', + OrganizationMemberJoined: 'organizationMemberJoined', + OrganizationMemberProductJoinRequested: 'organizationMemberProductJoinRequested', + OrganizationMemberProductJoinRequestRejected: 'organizationMemberProductJoinRequestRejected', + OrganizationMemberProductJoinRequestApproved: 'organizationMemberProductJoinRequestApproved', + CodeReferencesUploaded: 'codeReferencesUploaded', + CodeReferenceDeleted: 'codeReferenceDeleted', + CodeReferenceStaleBranchDeleted: 'codeReferenceStaleBranchDeleted', + SegmentCreated: 'segmentCreated', + SegmentChanged: 'segmentChanged', + SegmentDeleted: 'segmentDeleted', + WebhookSigningKeyDeleted: 'webhookSigningKeyDeleted', + WebhookSigningKeyCreated: 'webhookSigningKeyCreated' +} as const; +export type GetAuditlogsAuditLogTypeEnum = typeof GetAuditlogsAuditLogTypeEnum[keyof typeof GetAuditlogsAuditLogTypeEnum]; +/** + * @export + */ +export const GetOrganizationAuditlogsAuditLogTypeEnum = { + ProductCreated: 'productCreated', + ProductChanged: 'productChanged', + ProductOwnershipTransferred: 'productOwnershipTransferred', + ProductDeleted: 'productDeleted', + ProductsReordered: 'productsReordered', + TeamMemberInvited: 'teamMemberInvited', + TeamMemberInvitationRevoked: 'teamMemberInvitationRevoked', + TeamMemberJoined: 'teamMemberJoined', + TeamMemberPermissionGroupChanged: 'teamMemberPermissionGroupChanged', + TeamMemberRemoved: 'teamMemberRemoved', + TeamMemberLeft: 'teamMemberLeft', + TeamMemberInvitationChanged: 'teamMemberInvitationChanged', + TeamMemberInvitationResent: 'teamMemberInvitationResent', + TeamMemberInvitationRejected: 'teamMemberInvitationRejected', + ConfigCreated: 'configCreated', + ConfigChanged: 'configChanged', + ConfigDeleted: 'configDeleted', + ConfigsReordered: 'configsReordered', + EnvironmentCreated: 'environmentCreated', + EnvironmentChanged: 'environmentChanged', + EnvironmentDeleted: 'environmentDeleted', + EnvironmentsReordered: 'environmentsReordered', + SettingCreated: 'settingCreated', + SettingChanged: 'settingChanged', + SettingDeleted: 'settingDeleted', + SettingsReordered: 'settingsReordered', + SettingValueChanged: 'settingValueChanged', + WebHookCreated: 'webHookCreated', + WebHookChanged: 'webHookChanged', + WebHookDeleted: 'webHookDeleted', + PermissionGroupCreated: 'permissionGroupCreated', + PermissionGroupChanged: 'permissionGroupChanged', + PermissionGroupDeleted: 'permissionGroupDeleted', + PermissionGroupDefault: 'permissionGroupDefault', + ApiKeyAdded: 'apiKeyAdded', + ApiKeyRemoved: 'apiKeyRemoved', + IntegrationAdded: 'integrationAdded', + IntegrationChanged: 'integrationChanged', + IntegrationRemoved: 'integrationRemoved', + ApiKeyConnected: 'apiKeyConnected', + IntegrationLinkAdded: 'integrationLinkAdded', + IntegrationLinkRemoved: 'integrationLinkRemoved', + OrganizationAdded: 'organizationAdded', + OrganizationRemoved: 'organizationRemoved', + OrganizationChanged: 'organizationChanged', + OrganizationSubscriptionTypeChanged: 'organizationSubscriptionTypeChanged', + OrganizationAdminChanged: 'organizationAdminChanged', + OrganizationAdminLeft: 'organizationAdminLeft', + OrganizationAdminDisabled2Fa: 'organizationAdminDisabled2FA', + TagAdded: 'tagAdded', + TagChanged: 'tagChanged', + TagRemoved: 'tagRemoved', + SettingTagAdded: 'settingTagAdded', + SettingTagRemoved: 'settingTagRemoved', + PublicApiAccessTokenAdded: 'publicApiAccessTokenAdded', + PublicApiAccessTokenRemoved: 'publicApiAccessTokenRemoved', + DomainAdded: 'domainAdded', + DomainVerified: 'domainVerified', + DomainRemoved: 'domainRemoved', + DomainSamlConfigured: 'domainSamlConfigured', + DomainSamlDeleted: 'domainSamlDeleted', + AutoProvisioningConfigurationChanged: 'autoProvisioningConfigurationChanged', + SamlIdpConfigurationAdded: 'samlIdpConfigurationAdded', + SamlIdpConfigurationRemoved: 'samlIdpConfigurationRemoved', + SamlIdpConfigurationUpdated: 'samlIdpConfigurationUpdated', + OrganizationMemberJoined: 'organizationMemberJoined', + OrganizationMemberProductJoinRequested: 'organizationMemberProductJoinRequested', + OrganizationMemberProductJoinRequestRejected: 'organizationMemberProductJoinRequestRejected', + OrganizationMemberProductJoinRequestApproved: 'organizationMemberProductJoinRequestApproved', + CodeReferencesUploaded: 'codeReferencesUploaded', + CodeReferenceDeleted: 'codeReferenceDeleted', + CodeReferenceStaleBranchDeleted: 'codeReferenceStaleBranchDeleted', + SegmentCreated: 'segmentCreated', + SegmentChanged: 'segmentChanged', + SegmentDeleted: 'segmentDeleted', + WebhookSigningKeyDeleted: 'webhookSigningKeyDeleted', + WebhookSigningKeyCreated: 'webhookSigningKeyCreated' +} as const; +export type GetOrganizationAuditlogsAuditLogTypeEnum = typeof GetOrganizationAuditlogsAuditLogTypeEnum[keyof typeof GetOrganizationAuditlogsAuditLogTypeEnum]; diff --git a/api/integration-links-api.ts b/api/integration-links-api.ts index 6b18ac3..172ed0f 100644 --- a/api/integration-links-api.ts +++ b/api/integration-links-api.ts @@ -33,8 +33,6 @@ import { DeleteIntegrationLinkModel } from '../model'; import { IntegrationLinkDetailsModel } from '../model'; // @ts-ignore import { IntegrationLinkModel } from '../model'; -// @ts-ignore -import { IntegrationLinkType } from '../model'; /** * IntegrationLinksApi - axios parameter creator * @export @@ -46,13 +44,13 @@ export const IntegrationLinksApiAxiosParamCreator = function (configuration?: Co * @summary Add or update Integration link * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. - * @param {IntegrationLinkType} integrationLinkType The integration link\'s type. + * @param {AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum} integrationLinkType The integration link\'s type. * @param {string} key The key of the integration link. * @param {AddOrUpdateIntegrationLinkModel} [addOrUpdateIntegrationLinkModel] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addOrUpdateIntegrationLink: async (environmentId: string, settingId: number, integrationLinkType: IntegrationLinkType, key: string, addOrUpdateIntegrationLinkModel?: AddOrUpdateIntegrationLinkModel, options: RawAxiosRequestConfig = {}): Promise => { + addOrUpdateIntegrationLink: async (environmentId: string, settingId: number, integrationLinkType: AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum, key: string, addOrUpdateIntegrationLinkModel?: AddOrUpdateIntegrationLinkModel, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'environmentId' is not null or undefined assertParamExists('addOrUpdateIntegrationLink', 'environmentId', environmentId) // verify required parameter 'settingId' is not null or undefined @@ -100,12 +98,12 @@ export const IntegrationLinksApiAxiosParamCreator = function (configuration?: Co * @summary Delete Integration link * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. - * @param {IntegrationLinkType} integrationLinkType The integration\'s type. + * @param {DeleteIntegrationLinkIntegrationLinkTypeEnum} integrationLinkType The integration\'s type. * @param {string} key The key of the integration link. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteIntegrationLink: async (environmentId: string, settingId: number, integrationLinkType: IntegrationLinkType, key: string, options: RawAxiosRequestConfig = {}): Promise => { + deleteIntegrationLink: async (environmentId: string, settingId: number, integrationLinkType: DeleteIntegrationLinkIntegrationLinkTypeEnum, key: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'environmentId' is not null or undefined assertParamExists('deleteIntegrationLink', 'environmentId', environmentId) // verify required parameter 'settingId' is not null or undefined @@ -148,12 +146,12 @@ export const IntegrationLinksApiAxiosParamCreator = function (configuration?: Co /** * * @summary Get Integration link - * @param {IntegrationLinkType} integrationLinkType The integration link\'s type. + * @param {GetIntegrationLinkDetailsIntegrationLinkTypeEnum} integrationLinkType The integration link\'s type. * @param {string} key The key of the integration link. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIntegrationLinkDetails: async (integrationLinkType: IntegrationLinkType, key: string, options: RawAxiosRequestConfig = {}): Promise => { + getIntegrationLinkDetails: async (integrationLinkType: GetIntegrationLinkDetailsIntegrationLinkTypeEnum, key: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'integrationLinkType' is not null or undefined assertParamExists('getIntegrationLinkDetails', 'integrationLinkType', integrationLinkType) // verify required parameter 'key' is not null or undefined @@ -288,13 +286,13 @@ export const IntegrationLinksApiFp = function(configuration?: Configuration) { * @summary Add or update Integration link * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. - * @param {IntegrationLinkType} integrationLinkType The integration link\'s type. + * @param {AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum} integrationLinkType The integration link\'s type. * @param {string} key The key of the integration link. * @param {AddOrUpdateIntegrationLinkModel} [addOrUpdateIntegrationLinkModel] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async addOrUpdateIntegrationLink(environmentId: string, settingId: number, integrationLinkType: IntegrationLinkType, key: string, addOrUpdateIntegrationLinkModel?: AddOrUpdateIntegrationLinkModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async addOrUpdateIntegrationLink(environmentId: string, settingId: number, integrationLinkType: AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum, key: string, addOrUpdateIntegrationLinkModel?: AddOrUpdateIntegrationLinkModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.addOrUpdateIntegrationLink(environmentId, settingId, integrationLinkType, key, addOrUpdateIntegrationLinkModel, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IntegrationLinksApi.addOrUpdateIntegrationLink']?.[localVarOperationServerIndex]?.url; @@ -305,12 +303,12 @@ export const IntegrationLinksApiFp = function(configuration?: Configuration) { * @summary Delete Integration link * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. - * @param {IntegrationLinkType} integrationLinkType The integration\'s type. + * @param {DeleteIntegrationLinkIntegrationLinkTypeEnum} integrationLinkType The integration\'s type. * @param {string} key The key of the integration link. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteIntegrationLink(environmentId: string, settingId: number, integrationLinkType: IntegrationLinkType, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async deleteIntegrationLink(environmentId: string, settingId: number, integrationLinkType: DeleteIntegrationLinkIntegrationLinkTypeEnum, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIntegrationLink(environmentId, settingId, integrationLinkType, key, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IntegrationLinksApi.deleteIntegrationLink']?.[localVarOperationServerIndex]?.url; @@ -319,12 +317,12 @@ export const IntegrationLinksApiFp = function(configuration?: Configuration) { /** * * @summary Get Integration link - * @param {IntegrationLinkType} integrationLinkType The integration link\'s type. + * @param {GetIntegrationLinkDetailsIntegrationLinkTypeEnum} integrationLinkType The integration link\'s type. * @param {string} key The key of the integration link. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getIntegrationLinkDetails(integrationLinkType: IntegrationLinkType, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getIntegrationLinkDetails(integrationLinkType: GetIntegrationLinkDetailsIntegrationLinkTypeEnum, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIntegrationLinkDetails(integrationLinkType, key, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IntegrationLinksApi.getIntegrationLinkDetails']?.[localVarOperationServerIndex]?.url; @@ -372,13 +370,13 @@ export const IntegrationLinksApiFactory = function (configuration?: Configuratio * @summary Add or update Integration link * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. - * @param {IntegrationLinkType} integrationLinkType The integration link\'s type. + * @param {AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum} integrationLinkType The integration link\'s type. * @param {string} key The key of the integration link. * @param {AddOrUpdateIntegrationLinkModel} [addOrUpdateIntegrationLinkModel] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addOrUpdateIntegrationLink(environmentId: string, settingId: number, integrationLinkType: IntegrationLinkType, key: string, addOrUpdateIntegrationLinkModel?: AddOrUpdateIntegrationLinkModel, options?: any): AxiosPromise { + addOrUpdateIntegrationLink(environmentId: string, settingId: number, integrationLinkType: AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum, key: string, addOrUpdateIntegrationLinkModel?: AddOrUpdateIntegrationLinkModel, options?: any): AxiosPromise { return localVarFp.addOrUpdateIntegrationLink(environmentId, settingId, integrationLinkType, key, addOrUpdateIntegrationLinkModel, options).then((request) => request(axios, basePath)); }, /** @@ -386,23 +384,23 @@ export const IntegrationLinksApiFactory = function (configuration?: Configuratio * @summary Delete Integration link * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. - * @param {IntegrationLinkType} integrationLinkType The integration\'s type. + * @param {DeleteIntegrationLinkIntegrationLinkTypeEnum} integrationLinkType The integration\'s type. * @param {string} key The key of the integration link. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteIntegrationLink(environmentId: string, settingId: number, integrationLinkType: IntegrationLinkType, key: string, options?: any): AxiosPromise { + deleteIntegrationLink(environmentId: string, settingId: number, integrationLinkType: DeleteIntegrationLinkIntegrationLinkTypeEnum, key: string, options?: any): AxiosPromise { return localVarFp.deleteIntegrationLink(environmentId, settingId, integrationLinkType, key, options).then((request) => request(axios, basePath)); }, /** * * @summary Get Integration link - * @param {IntegrationLinkType} integrationLinkType The integration link\'s type. + * @param {GetIntegrationLinkDetailsIntegrationLinkTypeEnum} integrationLinkType The integration link\'s type. * @param {string} key The key of the integration link. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIntegrationLinkDetails(integrationLinkType: IntegrationLinkType, key: string, options?: any): AxiosPromise { + getIntegrationLinkDetails(integrationLinkType: GetIntegrationLinkDetailsIntegrationLinkTypeEnum, key: string, options?: any): AxiosPromise { return localVarFp.getIntegrationLinkDetails(integrationLinkType, key, options).then((request) => request(axios, basePath)); }, /** @@ -441,14 +439,14 @@ export class IntegrationLinksApi extends BaseAPI { * @summary Add or update Integration link * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. - * @param {IntegrationLinkType} integrationLinkType The integration link\'s type. + * @param {AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum} integrationLinkType The integration link\'s type. * @param {string} key The key of the integration link. * @param {AddOrUpdateIntegrationLinkModel} [addOrUpdateIntegrationLinkModel] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationLinksApi */ - public addOrUpdateIntegrationLink(environmentId: string, settingId: number, integrationLinkType: IntegrationLinkType, key: string, addOrUpdateIntegrationLinkModel?: AddOrUpdateIntegrationLinkModel, options?: RawAxiosRequestConfig) { + public addOrUpdateIntegrationLink(environmentId: string, settingId: number, integrationLinkType: AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum, key: string, addOrUpdateIntegrationLinkModel?: AddOrUpdateIntegrationLinkModel, options?: RawAxiosRequestConfig) { return IntegrationLinksApiFp(this.configuration).addOrUpdateIntegrationLink(environmentId, settingId, integrationLinkType, key, addOrUpdateIntegrationLinkModel, options).then((request) => request(this.axios, this.basePath)); } @@ -457,26 +455,26 @@ export class IntegrationLinksApi extends BaseAPI { * @summary Delete Integration link * @param {string} environmentId The identifier of the Environment. * @param {number} settingId The id of the Setting. - * @param {IntegrationLinkType} integrationLinkType The integration\'s type. + * @param {DeleteIntegrationLinkIntegrationLinkTypeEnum} integrationLinkType The integration\'s type. * @param {string} key The key of the integration link. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationLinksApi */ - public deleteIntegrationLink(environmentId: string, settingId: number, integrationLinkType: IntegrationLinkType, key: string, options?: RawAxiosRequestConfig) { + public deleteIntegrationLink(environmentId: string, settingId: number, integrationLinkType: DeleteIntegrationLinkIntegrationLinkTypeEnum, key: string, options?: RawAxiosRequestConfig) { return IntegrationLinksApiFp(this.configuration).deleteIntegrationLink(environmentId, settingId, integrationLinkType, key, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Get Integration link - * @param {IntegrationLinkType} integrationLinkType The integration link\'s type. + * @param {GetIntegrationLinkDetailsIntegrationLinkTypeEnum} integrationLinkType The integration link\'s type. * @param {string} key The key of the integration link. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IntegrationLinksApi */ - public getIntegrationLinkDetails(integrationLinkType: IntegrationLinkType, key: string, options?: RawAxiosRequestConfig) { + public getIntegrationLinkDetails(integrationLinkType: GetIntegrationLinkDetailsIntegrationLinkTypeEnum, key: string, options?: RawAxiosRequestConfig) { return IntegrationLinksApiFp(this.configuration).getIntegrationLinkDetails(integrationLinkType, key, options).then((request) => request(this.axios, this.basePath)); } @@ -506,3 +504,30 @@ export class IntegrationLinksApi extends BaseAPI { } } +/** + * @export + */ +export const AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum = { + Trello: 'trello', + Jira: 'jira', + Monday: 'monday' +} as const; +export type AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum = typeof AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum[keyof typeof AddOrUpdateIntegrationLinkIntegrationLinkTypeEnum]; +/** + * @export + */ +export const DeleteIntegrationLinkIntegrationLinkTypeEnum = { + Trello: 'trello', + Jira: 'jira', + Monday: 'monday' +} as const; +export type DeleteIntegrationLinkIntegrationLinkTypeEnum = typeof DeleteIntegrationLinkIntegrationLinkTypeEnum[keyof typeof DeleteIntegrationLinkIntegrationLinkTypeEnum]; +/** + * @export + */ +export const GetIntegrationLinkDetailsIntegrationLinkTypeEnum = { + Trello: 'trello', + Jira: 'jira', + Monday: 'monday' +} as const; +export type GetIntegrationLinkDetailsIntegrationLinkTypeEnum = typeof GetIntegrationLinkDetailsIntegrationLinkTypeEnum[keyof typeof GetIntegrationLinkDetailsIntegrationLinkTypeEnum]; diff --git a/model/audit-log-item-model.ts b/model/audit-log-item-model.ts index 9f4650c..dc0eae6 100644 --- a/model/audit-log-item-model.ts +++ b/model/audit-log-item-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { AuditLogType } from './audit-log-type'; /** * @@ -37,10 +34,10 @@ export interface AuditLogItemModel { 'auditLogDateTime'?: string; /** * - * @type {AuditLogType} + * @type {string} * @memberof AuditLogItemModel */ - 'auditLogTypeEnum'?: AuditLogType; + 'auditLogTypeEnum'?: AuditLogItemModelAuditLogTypeEnumEnum; /** * * @type {string} @@ -97,5 +94,86 @@ export interface AuditLogItemModel { 'details'?: string | null; } +export const AuditLogItemModelAuditLogTypeEnumEnum = { + ProductCreated: 'productCreated', + ProductChanged: 'productChanged', + ProductOwnershipTransferred: 'productOwnershipTransferred', + ProductDeleted: 'productDeleted', + ProductsReordered: 'productsReordered', + TeamMemberInvited: 'teamMemberInvited', + TeamMemberInvitationRevoked: 'teamMemberInvitationRevoked', + TeamMemberJoined: 'teamMemberJoined', + TeamMemberPermissionGroupChanged: 'teamMemberPermissionGroupChanged', + TeamMemberRemoved: 'teamMemberRemoved', + TeamMemberLeft: 'teamMemberLeft', + TeamMemberInvitationChanged: 'teamMemberInvitationChanged', + TeamMemberInvitationResent: 'teamMemberInvitationResent', + TeamMemberInvitationRejected: 'teamMemberInvitationRejected', + ConfigCreated: 'configCreated', + ConfigChanged: 'configChanged', + ConfigDeleted: 'configDeleted', + ConfigsReordered: 'configsReordered', + EnvironmentCreated: 'environmentCreated', + EnvironmentChanged: 'environmentChanged', + EnvironmentDeleted: 'environmentDeleted', + EnvironmentsReordered: 'environmentsReordered', + SettingCreated: 'settingCreated', + SettingChanged: 'settingChanged', + SettingDeleted: 'settingDeleted', + SettingsReordered: 'settingsReordered', + SettingValueChanged: 'settingValueChanged', + WebHookCreated: 'webHookCreated', + WebHookChanged: 'webHookChanged', + WebHookDeleted: 'webHookDeleted', + PermissionGroupCreated: 'permissionGroupCreated', + PermissionGroupChanged: 'permissionGroupChanged', + PermissionGroupDeleted: 'permissionGroupDeleted', + PermissionGroupDefault: 'permissionGroupDefault', + ApiKeyAdded: 'apiKeyAdded', + ApiKeyRemoved: 'apiKeyRemoved', + IntegrationAdded: 'integrationAdded', + IntegrationChanged: 'integrationChanged', + IntegrationRemoved: 'integrationRemoved', + ApiKeyConnected: 'apiKeyConnected', + IntegrationLinkAdded: 'integrationLinkAdded', + IntegrationLinkRemoved: 'integrationLinkRemoved', + OrganizationAdded: 'organizationAdded', + OrganizationRemoved: 'organizationRemoved', + OrganizationChanged: 'organizationChanged', + OrganizationSubscriptionTypeChanged: 'organizationSubscriptionTypeChanged', + OrganizationAdminChanged: 'organizationAdminChanged', + OrganizationAdminLeft: 'organizationAdminLeft', + OrganizationAdminDisabled2Fa: 'organizationAdminDisabled2FA', + TagAdded: 'tagAdded', + TagChanged: 'tagChanged', + TagRemoved: 'tagRemoved', + SettingTagAdded: 'settingTagAdded', + SettingTagRemoved: 'settingTagRemoved', + PublicApiAccessTokenAdded: 'publicApiAccessTokenAdded', + PublicApiAccessTokenRemoved: 'publicApiAccessTokenRemoved', + DomainAdded: 'domainAdded', + DomainVerified: 'domainVerified', + DomainRemoved: 'domainRemoved', + DomainSamlConfigured: 'domainSamlConfigured', + DomainSamlDeleted: 'domainSamlDeleted', + AutoProvisioningConfigurationChanged: 'autoProvisioningConfigurationChanged', + SamlIdpConfigurationAdded: 'samlIdpConfigurationAdded', + SamlIdpConfigurationRemoved: 'samlIdpConfigurationRemoved', + SamlIdpConfigurationUpdated: 'samlIdpConfigurationUpdated', + OrganizationMemberJoined: 'organizationMemberJoined', + OrganizationMemberProductJoinRequested: 'organizationMemberProductJoinRequested', + OrganizationMemberProductJoinRequestRejected: 'organizationMemberProductJoinRequestRejected', + OrganizationMemberProductJoinRequestApproved: 'organizationMemberProductJoinRequestApproved', + CodeReferencesUploaded: 'codeReferencesUploaded', + CodeReferenceDeleted: 'codeReferenceDeleted', + CodeReferenceStaleBranchDeleted: 'codeReferenceStaleBranchDeleted', + SegmentCreated: 'segmentCreated', + SegmentChanged: 'segmentChanged', + SegmentDeleted: 'segmentDeleted', + WebhookSigningKeyDeleted: 'webhookSigningKeyDeleted', + WebhookSigningKeyCreated: 'webhookSigningKeyCreated' +} as const; + +export type AuditLogItemModelAuditLogTypeEnumEnum = typeof AuditLogItemModelAuditLogTypeEnumEnum[keyof typeof AuditLogItemModelAuditLogTypeEnumEnum]; diff --git a/model/config-model.ts b/model/config-model.ts index d91d36f..2a4f18c 100644 --- a/model/config-model.ts +++ b/model/config-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { EvaluationVersion } from './evaluation-version'; // May contain unused imports in some cases // @ts-ignore import { ProductModel } from './product-model'; @@ -63,12 +60,18 @@ export interface ConfigModel { */ 'migratedConfigId'?: string | null; /** - * - * @type {EvaluationVersion} + * Determines the evaluation version of a Config. Using `v2` enables the new features of Config V2 (https://configcat.com/docs/advanced/config-v2). + * @type {string} * @memberof ConfigModel */ - 'evaluationVersion'?: EvaluationVersion; + 'evaluationVersion'?: ConfigModelEvaluationVersionEnum; } +export const ConfigModelEvaluationVersionEnum = { + V1: 'v1', + V2: 'v2' +} as const; + +export type ConfigModelEvaluationVersionEnum = typeof ConfigModelEvaluationVersionEnum[keyof typeof ConfigModelEvaluationVersionEnum]; diff --git a/model/create-config-request.ts b/model/create-config-request.ts index e41e0a4..7de8749 100644 --- a/model/create-config-request.ts +++ b/model/create-config-request.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { EvaluationVersion } from './evaluation-version'; /** * @@ -42,12 +39,18 @@ export interface CreateConfigRequest { */ 'order'?: number | null; /** - * - * @type {EvaluationVersion} + * Determines the evaluation version of a Config. Using `v2` enables the new features of Config V2 (https://configcat.com/docs/advanced/config-v2). + * @type {string} * @memberof CreateConfigRequest */ - 'evaluationVersion'?: EvaluationVersion; + 'evaluationVersion'?: CreateConfigRequestEvaluationVersionEnum; } +export const CreateConfigRequestEvaluationVersionEnum = { + V1: 'v1', + V2: 'v2' +} as const; + +export type CreateConfigRequestEvaluationVersionEnum = typeof CreateConfigRequestEvaluationVersionEnum[keyof typeof CreateConfigRequestEvaluationVersionEnum]; diff --git a/model/create-integration-model.ts b/model/create-integration-model.ts index ee290b1..74f5416 100644 --- a/model/create-integration-model.ts +++ b/model/create-integration-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { IntegrationType } from './integration-type'; /** * @@ -24,11 +21,11 @@ import { IntegrationType } from './integration-type'; */ export interface CreateIntegrationModel { /** - * - * @type {IntegrationType} + * Type of the Integration. + * @type {string} * @memberof CreateIntegrationModel */ - 'integrationType': IntegrationType; + 'integrationType': CreateIntegrationModelIntegrationTypeEnum; /** * Name of the Integration. * @type {string} @@ -55,5 +52,15 @@ export interface CreateIntegrationModel { 'configIds': Array; } +export const CreateIntegrationModelIntegrationTypeEnum = { + DataDog: 'dataDog', + Slack: 'slack', + Amplitude: 'amplitude', + MixPanel: 'mixPanel', + Segment: 'segment', + PubNub: 'pubNub' +} as const; + +export type CreateIntegrationModelIntegrationTypeEnum = typeof CreateIntegrationModelIntegrationTypeEnum[keyof typeof CreateIntegrationModelIntegrationTypeEnum]; diff --git a/model/create-or-update-environment-access-model.ts b/model/create-or-update-environment-access-model.ts index 3724a01..ac10b0d 100644 --- a/model/create-or-update-environment-access-model.ts +++ b/model/create-or-update-environment-access-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { EnvironmentAccessType } from './environment-access-type'; /** * @@ -30,12 +27,19 @@ export interface CreateOrUpdateEnvironmentAccessModel { */ 'environmentId'?: string; /** - * - * @type {EnvironmentAccessType} + * Represent the environment specific Feature Management permission. + * @type {string} * @memberof CreateOrUpdateEnvironmentAccessModel */ - 'environmentAccessType'?: EnvironmentAccessType; + 'environmentAccessType'?: CreateOrUpdateEnvironmentAccessModelEnvironmentAccessTypeEnum; } +export const CreateOrUpdateEnvironmentAccessModelEnvironmentAccessTypeEnum = { + Full: 'full', + ReadOnly: 'readOnly', + None: 'none' +} as const; + +export type CreateOrUpdateEnvironmentAccessModelEnvironmentAccessTypeEnum = typeof CreateOrUpdateEnvironmentAccessModelEnvironmentAccessTypeEnum[keyof typeof CreateOrUpdateEnvironmentAccessModelEnvironmentAccessTypeEnum]; diff --git a/model/create-permission-group-request.ts b/model/create-permission-group-request.ts index 3d5e547..8095592 100644 --- a/model/create-permission-group-request.ts +++ b/model/create-permission-group-request.ts @@ -13,15 +13,9 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { AccessType } from './access-type'; // May contain unused imports in some cases // @ts-ignore import { CreateOrUpdateEnvironmentAccessModel } from './create-or-update-environment-access-model'; -// May contain unused imports in some cases -// @ts-ignore -import { EnvironmentAccessType } from './environment-access-type'; /** * @@ -156,17 +150,17 @@ export interface CreatePermissionGroupRequest { */ 'canViewProductStatistics'?: boolean; /** - * - * @type {AccessType} + * Represent the Feature Management permission. + * @type {string} * @memberof CreatePermissionGroupRequest */ - 'accessType'?: AccessType; + 'accessType'?: CreatePermissionGroupRequestAccessTypeEnum; /** - * - * @type {EnvironmentAccessType} + * Represent the environment specific Feature Management permission. + * @type {string} * @memberof CreatePermissionGroupRequest */ - 'newEnvironmentAccessType'?: EnvironmentAccessType; + 'newEnvironmentAccessType'?: CreatePermissionGroupRequestNewEnvironmentAccessTypeEnum; /** * List of environment specific permissions. * @type {Array} @@ -175,5 +169,19 @@ export interface CreatePermissionGroupRequest { 'environmentAccesses'?: Array | null; } +export const CreatePermissionGroupRequestAccessTypeEnum = { + ReadOnly: 'readOnly', + Full: 'full', + Custom: 'custom' +} as const; + +export type CreatePermissionGroupRequestAccessTypeEnum = typeof CreatePermissionGroupRequestAccessTypeEnum[keyof typeof CreatePermissionGroupRequestAccessTypeEnum]; +export const CreatePermissionGroupRequestNewEnvironmentAccessTypeEnum = { + Full: 'full', + ReadOnly: 'readOnly', + None: 'none' +} as const; + +export type CreatePermissionGroupRequestNewEnvironmentAccessTypeEnum = typeof CreatePermissionGroupRequestNewEnvironmentAccessTypeEnum[keyof typeof CreatePermissionGroupRequestNewEnvironmentAccessTypeEnum]; diff --git a/model/create-segment-model.ts b/model/create-segment-model.ts index 67d4415..8fe73c7 100644 --- a/model/create-segment-model.ts +++ b/model/create-segment-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { RolloutRuleComparator } from './rollout-rule-comparator'; /** * @@ -43,10 +40,10 @@ export interface CreateSegmentModel { 'comparisonAttribute': string; /** * - * @type {RolloutRuleComparator} + * @type {string} * @memberof CreateSegmentModel */ - 'comparator': RolloutRuleComparator; + 'comparator': CreateSegmentModelComparatorEnum; /** * The value to compare with the given user attribute\'s value. * @type {string} @@ -55,5 +52,27 @@ export interface CreateSegmentModel { 'comparisonValue': string; } +export const CreateSegmentModelComparatorEnum = { + IsOneOf: 'isOneOf', + IsNotOneOf: 'isNotOneOf', + Contains: 'contains', + DoesNotContain: 'doesNotContain', + SemVerIsOneOf: 'semVerIsOneOf', + SemVerIsNotOneOf: 'semVerIsNotOneOf', + SemVerLess: 'semVerLess', + SemVerLessOrEquals: 'semVerLessOrEquals', + SemVerGreater: 'semVerGreater', + SemVerGreaterOrEquals: 'semVerGreaterOrEquals', + NumberEquals: 'numberEquals', + NumberDoesNotEqual: 'numberDoesNotEqual', + NumberLess: 'numberLess', + NumberLessOrEquals: 'numberLessOrEquals', + NumberGreater: 'numberGreater', + NumberGreaterOrEquals: 'numberGreaterOrEquals', + SensitiveIsOneOf: 'sensitiveIsOneOf', + SensitiveIsNotOneOf: 'sensitiveIsNotOneOf' +} as const; + +export type CreateSegmentModelComparatorEnum = typeof CreateSegmentModelComparatorEnum[keyof typeof CreateSegmentModelComparatorEnum]; diff --git a/model/create-setting-initial-values.ts b/model/create-setting-initial-values.ts index ebf1715..99f3441 100644 --- a/model/create-setting-initial-values.ts +++ b/model/create-setting-initial-values.ts @@ -16,9 +16,6 @@ // May contain unused imports in some cases // @ts-ignore import { InitialValue } from './initial-value'; -// May contain unused imports in some cases -// @ts-ignore -import { SettingType } from './setting-type'; /** * @@ -57,11 +54,11 @@ export interface CreateSettingInitialValues { */ 'name': string; /** - * - * @type {SettingType} + * The type of the Feature Flag or Setting. + * @type {string} * @memberof CreateSettingInitialValues */ - 'settingType': SettingType; + 'settingType': CreateSettingInitialValuesSettingTypeEnum; /** * Optional, initial value of the Feature Flag or Setting in the given Environments. * @type {Array} @@ -70,5 +67,13 @@ export interface CreateSettingInitialValues { 'initialValues'?: Array | null; } +export const CreateSettingInitialValuesSettingTypeEnum = { + Boolean: 'boolean', + String: 'string', + Int: 'int', + Double: 'double' +} as const; + +export type CreateSettingInitialValuesSettingTypeEnum = typeof CreateSettingInitialValuesSettingTypeEnum[keyof typeof CreateSettingInitialValuesSettingTypeEnum]; diff --git a/model/environment-access-model.ts b/model/environment-access-model.ts index 6e011c9..37e1568 100644 --- a/model/environment-access-model.ts +++ b/model/environment-access-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { EnvironmentAccessType } from './environment-access-type'; /** * @@ -60,12 +57,19 @@ export interface EnvironmentAccessModel { */ 'reasonRequired'?: boolean; /** - * - * @type {EnvironmentAccessType} + * Represent the environment specific Feature Management permission. + * @type {string} * @memberof EnvironmentAccessModel */ - 'environmentAccessType'?: EnvironmentAccessType; + 'environmentAccessType'?: EnvironmentAccessModelEnvironmentAccessTypeEnum; } +export const EnvironmentAccessModelEnvironmentAccessTypeEnum = { + Full: 'full', + ReadOnly: 'readOnly', + None: 'none' +} as const; + +export type EnvironmentAccessModelEnvironmentAccessTypeEnum = typeof EnvironmentAccessModelEnvironmentAccessTypeEnum[keyof typeof EnvironmentAccessModelEnvironmentAccessTypeEnum]; diff --git a/model/index.ts b/model/index.ts index d0b5480..33f3342 100644 --- a/model/index.ts +++ b/model/index.ts @@ -1,8 +1,6 @@ -export * from './access-type'; export * from './add-or-update-integration-link-model'; export * from './add-or-update-jira-integration-link-model'; export * from './audit-log-item-model'; -export * from './audit-log-type'; export * from './code-reference-model'; export * from './code-reference-request'; export * from './comparison-value-list-model'; @@ -26,27 +24,21 @@ export * from './create-tag-model'; export * from './delete-integration-link-model'; export * from './delete-repository-reports-request'; export * from './environment-access-model'; -export * from './environment-access-type'; export * from './environment-model'; -export * from './evaluation-version'; export * from './feature-flag-limitations'; export * from './flag-reference'; export * from './initial-value'; export * from './integration-link-detail'; export * from './integration-link-details-model'; export * from './integration-link-model'; -export * from './integration-link-type'; export * from './integration-model'; -export * from './integration-type'; export * from './integrations-model'; export * from './invitation-model'; export * from './invite-members-request'; export * from './json-patch-operation'; -export * from './key-generation-mode'; export * from './me-model'; export * from './member-model'; export * from './modify-integration-request'; -export * from './operation-type'; export * from './organization-admin-model'; export * from './organization-invitation-model'; export * from './organization-member-model'; @@ -58,7 +50,6 @@ export * from './organization-product-model'; export * from './percentage-option-model'; export * from './permission-group-model'; export * from './preferences-model'; -export * from './prerequisite-comparator'; export * from './prerequisite-flag-condition-model'; export * from './product-model'; export * from './reason-required-environment-model'; @@ -66,10 +57,8 @@ export * from './reference-line'; export * from './reference-lines'; export * from './replace-setting-model'; export * from './rollout-percentage-item-model'; -export * from './rollout-rule-comparator'; export * from './rollout-rule-model'; export * from './sdk-keys-model'; -export * from './segment-comparator'; export * from './segment-condition-model'; export * from './segment-list-model'; export * from './segment-model'; @@ -77,7 +66,6 @@ export * from './setting-data-model'; export * from './setting-formula-model'; export * from './setting-model'; export * from './setting-tag-model'; -export * from './setting-type'; export * from './setting-value-model'; export * from './tag-model'; export * from './targeting-rule-model'; @@ -96,11 +84,9 @@ export * from './update-setting-value-model'; export * from './update-setting-value-with-setting-id-model'; export * from './update-setting-values-with-id-model'; export * from './update-tag-model'; -export * from './user-comparator'; export * from './user-condition-model'; export * from './user-model'; export * from './value-model'; -export * from './web-hook-http-method'; export * from './web-hook-request'; export * from './webhook-config'; export * from './webhook-environment'; diff --git a/model/integration-link-model.ts b/model/integration-link-model.ts index 76d0781..53771d5 100644 --- a/model/integration-link-model.ts +++ b/model/integration-link-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { IntegrationLinkType } from './integration-link-type'; /** * @@ -37,10 +34,10 @@ export interface IntegrationLinkModel { 'description'?: string | null; /** * - * @type {IntegrationLinkType} + * @type {string} * @memberof IntegrationLinkModel */ - 'integrationLinkType'?: IntegrationLinkType; + 'integrationLinkType'?: IntegrationLinkModelIntegrationLinkTypeEnum; /** * * @type {string} @@ -49,5 +46,12 @@ export interface IntegrationLinkModel { 'url'?: string | null; } +export const IntegrationLinkModelIntegrationLinkTypeEnum = { + Trello: 'trello', + Jira: 'jira', + Monday: 'monday' +} as const; + +export type IntegrationLinkModelIntegrationLinkTypeEnum = typeof IntegrationLinkModelIntegrationLinkTypeEnum[keyof typeof IntegrationLinkModelIntegrationLinkTypeEnum]; diff --git a/model/integration-model.ts b/model/integration-model.ts index ff5465e..81721d3 100644 --- a/model/integration-model.ts +++ b/model/integration-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { IntegrationType } from './integration-type'; // May contain unused imports in some cases // @ts-ignore import { ProductModel } from './product-model'; @@ -45,11 +42,11 @@ export interface IntegrationModel { */ 'name'?: string | null; /** - * - * @type {IntegrationType} + * Type of the Integration. + * @type {string} * @memberof IntegrationModel */ - 'integrationType'?: IntegrationType; + 'integrationType'?: IntegrationModelIntegrationTypeEnum; /** * Parameters of the Integration. * @type {{ [key: string]: string | null; }} @@ -70,5 +67,15 @@ export interface IntegrationModel { 'configIds'?: Array | null; } +export const IntegrationModelIntegrationTypeEnum = { + DataDog: 'dataDog', + Slack: 'slack', + Amplitude: 'amplitude', + MixPanel: 'mixPanel', + Segment: 'segment', + PubNub: 'pubNub' +} as const; + +export type IntegrationModelIntegrationTypeEnum = typeof IntegrationModelIntegrationTypeEnum[keyof typeof IntegrationModelIntegrationTypeEnum]; diff --git a/model/json-patch-operation.ts b/model/json-patch-operation.ts index 6a619e8..a5b3256 100644 --- a/model/json-patch-operation.ts +++ b/model/json-patch-operation.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { OperationType } from './operation-type'; /** * @@ -24,11 +21,11 @@ import { OperationType } from './operation-type'; */ export interface JsonPatchOperation { /** - * - * @type {OperationType} + * The JSON Patch operation. (https://jsonpatch.com) + * @type {string} * @memberof JsonPatchOperation */ - 'op': OperationType; + 'op': JsonPatchOperationOpEnum; /** * The source path. * @type {string} @@ -49,5 +46,16 @@ export interface JsonPatchOperation { 'value'?: any | null; } +export const JsonPatchOperationOpEnum = { + Unknown: 'unknown', + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; diff --git a/model/permission-group-model.ts b/model/permission-group-model.ts index c2e0f94..31bc51b 100644 --- a/model/permission-group-model.ts +++ b/model/permission-group-model.ts @@ -13,17 +13,11 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { AccessType } from './access-type'; // May contain unused imports in some cases // @ts-ignore import { EnvironmentAccessModel } from './environment-access-model'; // May contain unused imports in some cases // @ts-ignore -import { EnvironmentAccessType } from './environment-access-type'; -// May contain unused imports in some cases -// @ts-ignore import { ProductModel } from './product-model'; /** @@ -165,17 +159,17 @@ export interface PermissionGroupModel { */ 'canViewProductStatistics'?: boolean; /** - * - * @type {AccessType} + * Represent the Feature Management permission. + * @type {string} * @memberof PermissionGroupModel */ - 'accessType'?: AccessType; + 'accessType'?: PermissionGroupModelAccessTypeEnum; /** - * - * @type {EnvironmentAccessType} + * Represent the environment specific Feature Management permission. + * @type {string} * @memberof PermissionGroupModel */ - 'newEnvironmentAccessType'?: EnvironmentAccessType; + 'newEnvironmentAccessType'?: PermissionGroupModelNewEnvironmentAccessTypeEnum; /** * List of environment specific permissions. * @type {Array} @@ -190,5 +184,19 @@ export interface PermissionGroupModel { 'product'?: ProductModel; } +export const PermissionGroupModelAccessTypeEnum = { + ReadOnly: 'readOnly', + Full: 'full', + Custom: 'custom' +} as const; + +export type PermissionGroupModelAccessTypeEnum = typeof PermissionGroupModelAccessTypeEnum[keyof typeof PermissionGroupModelAccessTypeEnum]; +export const PermissionGroupModelNewEnvironmentAccessTypeEnum = { + Full: 'full', + ReadOnly: 'readOnly', + None: 'none' +} as const; + +export type PermissionGroupModelNewEnvironmentAccessTypeEnum = typeof PermissionGroupModelNewEnvironmentAccessTypeEnum[keyof typeof PermissionGroupModelNewEnvironmentAccessTypeEnum]; diff --git a/model/preferences-model.ts b/model/preferences-model.ts index 1db2222..9fb11e6 100644 --- a/model/preferences-model.ts +++ b/model/preferences-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { KeyGenerationMode } from './key-generation-mode'; // May contain unused imports in some cases // @ts-ignore import { ReasonRequiredEnvironmentModel } from './reason-required-environment-model'; @@ -33,11 +30,11 @@ export interface PreferencesModel { */ 'reasonRequired'?: boolean; /** - * - * @type {KeyGenerationMode} + * Determines the Feature Flag key generation mode. + * @type {string} * @memberof PreferencesModel */ - 'keyGenerationMode'?: KeyGenerationMode; + 'keyGenerationMode'?: PreferencesModelKeyGenerationModeEnum; /** * Indicates whether a variation ID\'s must be shown on the ConfigCat Dashboard. * @type {boolean} @@ -58,5 +55,14 @@ export interface PreferencesModel { 'mandatorySettingHint'?: boolean; } +export const PreferencesModelKeyGenerationModeEnum = { + CamelCase: 'camelCase', + LowerCase: 'lowerCase', + UpperCase: 'upperCase', + PascalCase: 'pascalCase', + KebabCase: 'kebabCase' +} as const; + +export type PreferencesModelKeyGenerationModeEnum = typeof PreferencesModelKeyGenerationModeEnum[keyof typeof PreferencesModelKeyGenerationModeEnum]; diff --git a/model/prerequisite-flag-condition-model.ts b/model/prerequisite-flag-condition-model.ts index bcbe1a8..341d1c5 100644 --- a/model/prerequisite-flag-condition-model.ts +++ b/model/prerequisite-flag-condition-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { PrerequisiteComparator } from './prerequisite-comparator'; // May contain unused imports in some cases // @ts-ignore import { ValueModel } from './value-model'; @@ -33,11 +30,11 @@ export interface PrerequisiteFlagConditionModel { */ 'prerequisiteSettingId': number; /** - * - * @type {PrerequisiteComparator} + * Prerequisite flag comparison operator used during the evaluation process. + * @type {string} * @memberof PrerequisiteFlagConditionModel */ - 'comparator': PrerequisiteComparator; + 'comparator': PrerequisiteFlagConditionModelComparatorEnum; /** * * @type {ValueModel} @@ -46,5 +43,11 @@ export interface PrerequisiteFlagConditionModel { 'prerequisiteComparisonValue': ValueModel; } +export const PrerequisiteFlagConditionModelComparatorEnum = { + Equals: 'equals', + DoesNotEqual: 'doesNotEqual' +} as const; + +export type PrerequisiteFlagConditionModelComparatorEnum = typeof PrerequisiteFlagConditionModelComparatorEnum[keyof typeof PrerequisiteFlagConditionModelComparatorEnum]; diff --git a/model/rollout-rule-model.ts b/model/rollout-rule-model.ts index da3c45c..1e42867 100644 --- a/model/rollout-rule-model.ts +++ b/model/rollout-rule-model.ts @@ -13,12 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { RolloutRuleComparator } from './rollout-rule-comparator'; -// May contain unused imports in some cases -// @ts-ignore -import { SegmentComparator } from './segment-comparator'; /** * @@ -34,10 +28,10 @@ export interface RolloutRuleModel { 'comparisonAttribute'?: string | null; /** * - * @type {RolloutRuleComparator} + * @type {string} * @memberof RolloutRuleModel */ - 'comparator'?: RolloutRuleComparator; + 'comparator'?: RolloutRuleModelComparatorEnum | null; /** * The value to compare against. * @type {string} @@ -51,11 +45,11 @@ export interface RolloutRuleModel { */ 'value'?: any | null; /** - * - * @type {SegmentComparator} + * The segment comparison operator. + * @type {string} * @memberof RolloutRuleModel */ - 'segmentComparator'?: SegmentComparator; + 'segmentComparator'?: RolloutRuleModelSegmentComparatorEnum | null; /** * The segment to compare against. * @type {string} @@ -64,5 +58,33 @@ export interface RolloutRuleModel { 'segmentId'?: string | null; } +export const RolloutRuleModelComparatorEnum = { + IsOneOf: 'isOneOf', + IsNotOneOf: 'isNotOneOf', + Contains: 'contains', + DoesNotContain: 'doesNotContain', + SemVerIsOneOf: 'semVerIsOneOf', + SemVerIsNotOneOf: 'semVerIsNotOneOf', + SemVerLess: 'semVerLess', + SemVerLessOrEquals: 'semVerLessOrEquals', + SemVerGreater: 'semVerGreater', + SemVerGreaterOrEquals: 'semVerGreaterOrEquals', + NumberEquals: 'numberEquals', + NumberDoesNotEqual: 'numberDoesNotEqual', + NumberLess: 'numberLess', + NumberLessOrEquals: 'numberLessOrEquals', + NumberGreater: 'numberGreater', + NumberGreaterOrEquals: 'numberGreaterOrEquals', + SensitiveIsOneOf: 'sensitiveIsOneOf', + SensitiveIsNotOneOf: 'sensitiveIsNotOneOf' +} as const; + +export type RolloutRuleModelComparatorEnum = typeof RolloutRuleModelComparatorEnum[keyof typeof RolloutRuleModelComparatorEnum]; +export const RolloutRuleModelSegmentComparatorEnum = { + IsIn: 'isIn', + IsNotIn: 'isNotIn' +} as const; + +export type RolloutRuleModelSegmentComparatorEnum = typeof RolloutRuleModelSegmentComparatorEnum[keyof typeof RolloutRuleModelSegmentComparatorEnum]; diff --git a/model/segment-condition-model.ts b/model/segment-condition-model.ts index d614864..c726386 100644 --- a/model/segment-condition-model.ts +++ b/model/segment-condition-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { SegmentComparator } from './segment-comparator'; /** * Describes a condition that is based on a segment. @@ -30,12 +27,18 @@ export interface SegmentConditionModel { */ 'segmentId': string; /** - * - * @type {SegmentComparator} + * The segment comparison operator used during the evaluation process. + * @type {string} * @memberof SegmentConditionModel */ - 'comparator': SegmentComparator; + 'comparator': SegmentConditionModelComparatorEnum; } +export const SegmentConditionModelComparatorEnum = { + IsIn: 'isIn', + IsNotIn: 'isNotIn' +} as const; + +export type SegmentConditionModelComparatorEnum = typeof SegmentConditionModelComparatorEnum[keyof typeof SegmentConditionModelComparatorEnum]; diff --git a/model/segment-model.ts b/model/segment-model.ts index 994a56e..8c29663 100644 --- a/model/segment-model.ts +++ b/model/segment-model.ts @@ -16,9 +16,6 @@ // May contain unused imports in some cases // @ts-ignore import { ProductModel } from './product-model'; -// May contain unused imports in some cases -// @ts-ignore -import { RolloutRuleComparator } from './rollout-rule-comparator'; /** * @@ -93,11 +90,11 @@ export interface SegmentModel { */ 'comparisonAttribute'?: string | null; /** - * - * @type {RolloutRuleComparator} + * The comparison operator the evaluation process must use when it compares the given user attribute\'s value with the comparison value. + * @type {string} * @memberof SegmentModel */ - 'comparator'?: RolloutRuleComparator; + 'comparator'?: SegmentModelComparatorEnum; /** * The value to compare with the given user attribute\'s value. * @type {string} @@ -106,5 +103,27 @@ export interface SegmentModel { 'comparisonValue'?: string | null; } +export const SegmentModelComparatorEnum = { + IsOneOf: 'isOneOf', + IsNotOneOf: 'isNotOneOf', + Contains: 'contains', + DoesNotContain: 'doesNotContain', + SemVerIsOneOf: 'semVerIsOneOf', + SemVerIsNotOneOf: 'semVerIsNotOneOf', + SemVerLess: 'semVerLess', + SemVerLessOrEquals: 'semVerLessOrEquals', + SemVerGreater: 'semVerGreater', + SemVerGreaterOrEquals: 'semVerGreaterOrEquals', + NumberEquals: 'numberEquals', + NumberDoesNotEqual: 'numberDoesNotEqual', + NumberLess: 'numberLess', + NumberLessOrEquals: 'numberLessOrEquals', + NumberGreater: 'numberGreater', + NumberGreaterOrEquals: 'numberGreaterOrEquals', + SensitiveIsOneOf: 'sensitiveIsOneOf', + SensitiveIsNotOneOf: 'sensitiveIsNotOneOf' +} as const; + +export type SegmentModelComparatorEnum = typeof SegmentModelComparatorEnum[keyof typeof SegmentModelComparatorEnum]; diff --git a/model/setting-data-model.ts b/model/setting-data-model.ts index b369e88..15653e7 100644 --- a/model/setting-data-model.ts +++ b/model/setting-data-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { SettingType } from './setting-type'; /** * Metadata of a Feature Flag or Setting. @@ -48,11 +45,11 @@ export interface SettingDataModel { */ 'hint'?: string | null; /** - * - * @type {SettingType} + * The type of the Feature Flag or Setting. + * @type {string} * @memberof SettingDataModel */ - 'settingType'?: SettingType; + 'settingType'?: SettingDataModelSettingTypeEnum; /** * The order of the Feature Flag or Setting represented on the ConfigCat Dashboard. * @type {number} @@ -85,5 +82,13 @@ export interface SettingDataModel { 'isWatching'?: boolean; } +export const SettingDataModelSettingTypeEnum = { + Boolean: 'boolean', + String: 'string', + Int: 'int', + Double: 'double' +} as const; + +export type SettingDataModelSettingTypeEnum = typeof SettingDataModelSettingTypeEnum[keyof typeof SettingDataModelSettingTypeEnum]; diff --git a/model/setting-model.ts b/model/setting-model.ts index d48342e..60e317a 100644 --- a/model/setting-model.ts +++ b/model/setting-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { SettingType } from './setting-type'; // May contain unused imports in some cases // @ts-ignore import { TagModel } from './tag-model'; @@ -57,11 +54,11 @@ export interface SettingModel { */ 'order'?: number; /** - * - * @type {SettingType} + * The type of the Feature Flag or Setting. + * @type {string} * @memberof SettingModel */ - 'settingType'?: SettingType; + 'settingType'?: SettingModelSettingTypeEnum; /** * Identifier of the Feature Flag\'s Config. * @type {string} @@ -82,5 +79,13 @@ export interface SettingModel { 'tags'?: Array | null; } +export const SettingModelSettingTypeEnum = { + Boolean: 'boolean', + String: 'string', + Int: 'int', + Double: 'double' +} as const; + +export type SettingModelSettingTypeEnum = typeof SettingModelSettingTypeEnum[keyof typeof SettingModelSettingTypeEnum]; diff --git a/model/update-permission-group-request.ts b/model/update-permission-group-request.ts index 99caab8..55f3952 100644 --- a/model/update-permission-group-request.ts +++ b/model/update-permission-group-request.ts @@ -13,15 +13,9 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { AccessType } from './access-type'; // May contain unused imports in some cases // @ts-ignore import { CreateOrUpdateEnvironmentAccessModel } from './create-or-update-environment-access-model'; -// May contain unused imports in some cases -// @ts-ignore -import { EnvironmentAccessType } from './environment-access-type'; /** * @@ -157,16 +151,16 @@ export interface UpdatePermissionGroupRequest { 'canViewProductStatistics'?: boolean | null; /** * - * @type {AccessType} + * @type {string} * @memberof UpdatePermissionGroupRequest */ - 'accessType'?: AccessType; + 'accessType'?: UpdatePermissionGroupRequestAccessTypeEnum | null; /** * - * @type {EnvironmentAccessType} + * @type {string} * @memberof UpdatePermissionGroupRequest */ - 'newEnvironmentAccessType'?: EnvironmentAccessType; + 'newEnvironmentAccessType'?: UpdatePermissionGroupRequestNewEnvironmentAccessTypeEnum | null; /** * List of environment specific permissions. * @type {Array} @@ -175,5 +169,19 @@ export interface UpdatePermissionGroupRequest { 'environmentAccesses'?: Array | null; } +export const UpdatePermissionGroupRequestAccessTypeEnum = { + ReadOnly: 'readOnly', + Full: 'full', + Custom: 'custom' +} as const; + +export type UpdatePermissionGroupRequestAccessTypeEnum = typeof UpdatePermissionGroupRequestAccessTypeEnum[keyof typeof UpdatePermissionGroupRequestAccessTypeEnum]; +export const UpdatePermissionGroupRequestNewEnvironmentAccessTypeEnum = { + Full: 'full', + ReadOnly: 'readOnly', + None: 'none' +} as const; + +export type UpdatePermissionGroupRequestNewEnvironmentAccessTypeEnum = typeof UpdatePermissionGroupRequestNewEnvironmentAccessTypeEnum[keyof typeof UpdatePermissionGroupRequestNewEnvironmentAccessTypeEnum]; diff --git a/model/update-preferences-request.ts b/model/update-preferences-request.ts index f8c2d15..fab4f81 100644 --- a/model/update-preferences-request.ts +++ b/model/update-preferences-request.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { KeyGenerationMode } from './key-generation-mode'; // May contain unused imports in some cases // @ts-ignore import { UpdateReasonRequiredEnvironmentModel } from './update-reason-required-environment-model'; @@ -33,11 +30,11 @@ export interface UpdatePreferencesRequest { */ 'reasonRequired'?: boolean | null; /** - * - * @type {KeyGenerationMode} + * Determines the Feature Flag key generation mode. + * @type {string} * @memberof UpdatePreferencesRequest */ - 'keyGenerationMode'?: KeyGenerationMode; + 'keyGenerationMode'?: UpdatePreferencesRequestKeyGenerationModeEnum | null; /** * Indicates whether a variation ID\'s must be shown on the ConfigCat Dashboard. * @type {boolean} @@ -58,5 +55,14 @@ export interface UpdatePreferencesRequest { 'reasonRequiredEnvironments'?: Array | null; } +export const UpdatePreferencesRequestKeyGenerationModeEnum = { + CamelCase: 'camelCase', + LowerCase: 'lowerCase', + UpperCase: 'upperCase', + PascalCase: 'pascalCase', + KebabCase: 'kebabCase' +} as const; + +export type UpdatePreferencesRequestKeyGenerationModeEnum = typeof UpdatePreferencesRequestKeyGenerationModeEnum[keyof typeof UpdatePreferencesRequestKeyGenerationModeEnum]; diff --git a/model/update-segment-model.ts b/model/update-segment-model.ts index cf63fa0..28a2cd9 100644 --- a/model/update-segment-model.ts +++ b/model/update-segment-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { RolloutRuleComparator } from './rollout-rule-comparator'; /** * @@ -43,10 +40,10 @@ export interface UpdateSegmentModel { 'comparisonAttribute'?: string | null; /** * - * @type {RolloutRuleComparator} + * @type {string} * @memberof UpdateSegmentModel */ - 'comparator'?: RolloutRuleComparator; + 'comparator'?: UpdateSegmentModelComparatorEnum | null; /** * * @type {string} @@ -55,5 +52,27 @@ export interface UpdateSegmentModel { 'comparisonValue'?: string | null; } +export const UpdateSegmentModelComparatorEnum = { + IsOneOf: 'isOneOf', + IsNotOneOf: 'isNotOneOf', + Contains: 'contains', + DoesNotContain: 'doesNotContain', + SemVerIsOneOf: 'semVerIsOneOf', + SemVerIsNotOneOf: 'semVerIsNotOneOf', + SemVerLess: 'semVerLess', + SemVerLessOrEquals: 'semVerLessOrEquals', + SemVerGreater: 'semVerGreater', + SemVerGreaterOrEquals: 'semVerGreaterOrEquals', + NumberEquals: 'numberEquals', + NumberDoesNotEqual: 'numberDoesNotEqual', + NumberLess: 'numberLess', + NumberLessOrEquals: 'numberLessOrEquals', + NumberGreater: 'numberGreater', + NumberGreaterOrEquals: 'numberGreaterOrEquals', + SensitiveIsOneOf: 'sensitiveIsOneOf', + SensitiveIsNotOneOf: 'sensitiveIsNotOneOf' +} as const; + +export type UpdateSegmentModelComparatorEnum = typeof UpdateSegmentModelComparatorEnum[keyof typeof UpdateSegmentModelComparatorEnum]; diff --git a/model/user-condition-model.ts b/model/user-condition-model.ts index 1325bea..d36ac6d 100644 --- a/model/user-condition-model.ts +++ b/model/user-condition-model.ts @@ -16,9 +16,6 @@ // May contain unused imports in some cases // @ts-ignore import { ComparisonValueModel } from './comparison-value-model'; -// May contain unused imports in some cases -// @ts-ignore -import { UserComparator } from './user-comparator'; /** * Describes a condition that is based on user attributes. @@ -33,11 +30,11 @@ export interface UserConditionModel { */ 'comparisonAttribute': string; /** - * - * @type {UserComparator} + * The comparison operator which defines the relation between the comparison attribute and the comparison value. + * @type {string} * @memberof UserConditionModel */ - 'comparator': UserComparator; + 'comparator': UserConditionModelComparatorEnum; /** * * @type {ComparisonValueModel} @@ -46,5 +43,45 @@ export interface UserConditionModel { 'comparisonValue': ComparisonValueModel; } +export const UserConditionModelComparatorEnum = { + IsOneOf: 'isOneOf', + IsNotOneOf: 'isNotOneOf', + ContainsAnyOf: 'containsAnyOf', + DoesNotContainAnyOf: 'doesNotContainAnyOf', + SemVerIsOneOf: 'semVerIsOneOf', + SemVerIsNotOneOf: 'semVerIsNotOneOf', + SemVerLess: 'semVerLess', + SemVerLessOrEquals: 'semVerLessOrEquals', + SemVerGreater: 'semVerGreater', + SemVerGreaterOrEquals: 'semVerGreaterOrEquals', + NumberEquals: 'numberEquals', + NumberDoesNotEqual: 'numberDoesNotEqual', + NumberLess: 'numberLess', + NumberLessOrEquals: 'numberLessOrEquals', + NumberGreater: 'numberGreater', + NumberGreaterOrEquals: 'numberGreaterOrEquals', + SensitiveIsOneOf: 'sensitiveIsOneOf', + SensitiveIsNotOneOf: 'sensitiveIsNotOneOf', + DateTimeBefore: 'dateTimeBefore', + DateTimeAfter: 'dateTimeAfter', + SensitiveTextEquals: 'sensitiveTextEquals', + SensitiveTextDoesNotEqual: 'sensitiveTextDoesNotEqual', + SensitiveTextStartsWithAnyOf: 'sensitiveTextStartsWithAnyOf', + SensitiveTextNotStartsWithAnyOf: 'sensitiveTextNotStartsWithAnyOf', + SensitiveTextEndsWithAnyOf: 'sensitiveTextEndsWithAnyOf', + SensitiveTextNotEndsWithAnyOf: 'sensitiveTextNotEndsWithAnyOf', + SensitiveArrayContainsAnyOf: 'sensitiveArrayContainsAnyOf', + SensitiveArrayDoesNotContainAnyOf: 'sensitiveArrayDoesNotContainAnyOf', + TextEquals: 'textEquals', + TextDoesNotEqual: 'textDoesNotEqual', + TextStartsWithAnyOf: 'textStartsWithAnyOf', + TextNotStartsWithAnyOf: 'textNotStartsWithAnyOf', + TextEndsWithAnyOf: 'textEndsWithAnyOf', + TextNotEndsWithAnyOf: 'textNotEndsWithAnyOf', + ArrayContainsAnyOf: 'arrayContainsAnyOf', + ArrayDoesNotContainAnyOf: 'arrayDoesNotContainAnyOf' +} as const; + +export type UserConditionModelComparatorEnum = typeof UserConditionModelComparatorEnum[keyof typeof UserConditionModelComparatorEnum]; diff --git a/model/web-hook-request.ts b/model/web-hook-request.ts index f029945..31b89ba 100644 --- a/model/web-hook-request.ts +++ b/model/web-hook-request.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { WebHookHttpMethod } from './web-hook-http-method'; // May contain unused imports in some cases // @ts-ignore import { WebhookHeaderModel } from './webhook-header-model'; @@ -39,11 +36,11 @@ export interface WebHookRequest { */ 'content'?: string | null; /** - * - * @type {WebHookHttpMethod} + * The HTTP method of the remote endpoint. + * @type {string} * @memberof WebHookRequest */ - 'httpMethod'?: WebHookHttpMethod; + 'httpMethod'?: WebHookRequestHttpMethodEnum; /** * List of HTTP headers. * @type {Array} @@ -52,5 +49,11 @@ export interface WebHookRequest { 'webHookHeaders'?: Array | null; } +export const WebHookRequestHttpMethodEnum = { + Get: 'get', + Post: 'post' +} as const; + +export type WebHookRequestHttpMethodEnum = typeof WebHookRequestHttpMethodEnum[keyof typeof WebHookRequestHttpMethodEnum]; diff --git a/model/webhook-model.ts b/model/webhook-model.ts index b9ede12..57e330c 100644 --- a/model/webhook-model.ts +++ b/model/webhook-model.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import { WebHookHttpMethod } from './web-hook-http-method'; // May contain unused imports in some cases // @ts-ignore import { WebhookConfig } from './webhook-config'; @@ -45,11 +42,11 @@ export interface WebhookModel { */ 'url'?: string | null; /** - * - * @type {WebHookHttpMethod} + * The HTTP method. + * @type {string} * @memberof WebhookModel */ - 'httpMethod'?: WebHookHttpMethod; + 'httpMethod'?: WebhookModelHttpMethodEnum; /** * The HTTP body content. * @type {string} @@ -76,5 +73,11 @@ export interface WebhookModel { 'environment'?: WebhookEnvironment; } +export const WebhookModelHttpMethodEnum = { + Get: 'get', + Post: 'post' +} as const; + +export type WebhookModelHttpMethodEnum = typeof WebhookModelHttpMethodEnum[keyof typeof WebhookModelHttpMethodEnum];