diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 39b03c5..723d3be 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -87,6 +87,7 @@ model/modify-integration-request.ts model/operation-type.ts model/organization-admin-model.ts model/organization-invitation-model.ts +model/organization-limitations.ts model/organization-member-model.ts model/organization-members-model.ts model/organization-model.ts @@ -95,9 +96,13 @@ model/organization-permission-model.ts model/organization-product-model.ts model/percentage-option-model.ts model/permission-group-model.ts +model/predefined-variation-environment-model.ts model/predefined-variation-model.ts +model/predefined-variation-usage-model.ts model/predefined-variation-value-model.ts +model/predefined-variation-with-usages-model.ts model/predefined-variations-model.ts +model/predefined-variations-with-usages-model.ts model/preferences-model.ts model/prerequisite-comparator.ts model/prerequisite-flag-condition-model.ts diff --git a/api/feature-flags-settings-api.ts b/api/feature-flags-settings-api.ts index 9e4d3ad..9782f74 100644 --- a/api/feature-flags-settings-api.ts +++ b/api/feature-flags-settings-api.ts @@ -28,6 +28,8 @@ import { JsonPatchOperation } from '../model'; // @ts-ignore import { PredefinedVariationsModel } from '../model'; // @ts-ignore +import { PredefinedVariationsWithUsagesModel } from '../model'; +// @ts-ignore import { ReplaceSettingModel } from '../model'; // @ts-ignore import { SettingModel } from '../model'; @@ -112,6 +114,44 @@ export const FeatureFlagsSettingsApiAxiosParamCreator = function (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 predefined variations along with their usages in the Environments for a Feature Flag or Setting identified by the `settingId` parameter. **Beta feature:** The feature is currently in closed beta state and cannot be used. + * @summary Get predefined variations (Beta) + * @param {number} settingId The identifier of the Setting. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPredefinedVariations: async (settingId: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'settingId' is not null or undefined + assertParamExists('getPredefinedVariations', 'settingId', settingId) + const localVarPath = `/v1/settings/{settingId}/predefined-variations` + .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: '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}; @@ -366,6 +406,19 @@ export const FeatureFlagsSettingsApiFp = function(configuration?: Configuration) const localVarOperationServerBasePath = operationServerMap['FeatureFlagsSettingsApi.deleteSetting']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * This endpoint returns the predefined variations along with their usages in the Environments for a Feature Flag or Setting identified by the `settingId` parameter. **Beta feature:** The feature is currently in closed beta state and cannot be used. + * @summary Get predefined variations (Beta) + * @param {number} settingId The identifier of the Setting. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getPredefinedVariations(settingId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPredefinedVariations(settingId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['FeatureFlagsSettingsApi.getPredefinedVariations']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter. * @summary Get Flag @@ -465,6 +518,16 @@ export const FeatureFlagsSettingsApiFactory = function (configuration?: Configur deleteSetting(settingId: number, options?: any): AxiosPromise { return localVarFp.deleteSetting(settingId, options).then((request) => request(axios, basePath)); }, + /** + * This endpoint returns the predefined variations along with their usages in the Environments for a Feature Flag or Setting identified by the `settingId` parameter. **Beta feature:** The feature is currently in closed beta state and cannot be used. + * @summary Get predefined variations (Beta) + * @param {number} settingId The identifier of the Setting. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPredefinedVariations(settingId: number, options?: any): AxiosPromise { + return localVarFp.getPredefinedVariations(settingId, options).then((request) => request(axios, basePath)); + }, /** * This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter. * @summary Get Flag @@ -553,6 +616,18 @@ export class FeatureFlagsSettingsApi extends BaseAPI { return FeatureFlagsSettingsApiFp(this.configuration).deleteSetting(settingId, options).then((request) => request(this.axios, this.basePath)); } + /** + * This endpoint returns the predefined variations along with their usages in the Environments for a Feature Flag or Setting identified by the `settingId` parameter. **Beta feature:** The feature is currently in closed beta state and cannot be used. + * @summary Get predefined variations (Beta) + * @param {number} settingId The identifier of the Setting. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FeatureFlagsSettingsApi + */ + public getPredefinedVariations(settingId: number, options?: RawAxiosRequestConfig) { + return FeatureFlagsSettingsApiFp(this.configuration).getPredefinedVariations(settingId, options).then((request) => request(this.axios, this.basePath)); + } + /** * This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter. * @summary Get Flag diff --git a/api/organizations-api.ts b/api/organizations-api.ts index e480f61..0f478f3 100644 --- a/api/organizations-api.ts +++ b/api/organizations-api.ts @@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore +import { OrganizationLimitations } from '../model'; +// @ts-ignore import { OrganizationModel } from '../model'; /** * OrganizationsApi - axios parameter creator @@ -29,6 +31,44 @@ import { OrganizationModel } from '../model'; */ export const OrganizationsApiAxiosParamCreator = function (configuration?: Configuration) { return { + /** + * This endpoint returns the limitations of an Organization identified by the `organizationId`. + * @summary Get Organization limitations + * @param {string} organizationId The identifier of the Organization. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganizationLimitations: async (organizationId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'organizationId' is not null or undefined + assertParamExists('getOrganizationLimitations', 'organizationId', organizationId) + const localVarPath = `/v1/organizations/{organizationId}/organization-limitations` + .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}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * This endpoint returns the list of the Organizations that belongs to the user. * @summary List Organizations @@ -73,6 +113,19 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi export const OrganizationsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = OrganizationsApiAxiosParamCreator(configuration) return { + /** + * This endpoint returns the limitations of an Organization identified by the `organizationId`. + * @summary Get Organization limitations + * @param {string} organizationId The identifier of the Organization. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getOrganizationLimitations(organizationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationLimitations(organizationId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OrganizationsApi.getOrganizationLimitations']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * This endpoint returns the list of the Organizations that belongs to the user. * @summary List Organizations @@ -95,6 +148,16 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { export const OrganizationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = OrganizationsApiFp(configuration) return { + /** + * This endpoint returns the limitations of an Organization identified by the `organizationId`. + * @summary Get Organization limitations + * @param {string} organizationId The identifier of the Organization. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganizationLimitations(organizationId: string, options?: any): AxiosPromise { + return localVarFp.getOrganizationLimitations(organizationId, options).then((request) => request(axios, basePath)); + }, /** * This endpoint returns the list of the Organizations that belongs to the user. * @summary List Organizations @@ -114,6 +177,18 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, * @extends {BaseAPI} */ export class OrganizationsApi extends BaseAPI { + /** + * This endpoint returns the limitations of an Organization identified by the `organizationId`. + * @summary Get Organization limitations + * @param {string} organizationId The identifier of the Organization. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationsApi + */ + public getOrganizationLimitations(organizationId: string, options?: RawAxiosRequestConfig) { + return OrganizationsApiFp(this.configuration).getOrganizationLimitations(organizationId, options).then((request) => request(this.axios, this.basePath)); + } + /** * This endpoint returns the list of the Organizations that belongs to the user. * @summary List Organizations diff --git a/model/environment-access-model.ts b/model/environment-access-model.ts index e33bb09..04cabcb 100644 --- a/model/environment-access-model.ts +++ b/model/environment-access-model.ts @@ -34,7 +34,7 @@ export interface EnvironmentAccessModel { * @type {string} * @memberof EnvironmentAccessModel */ - 'name': string | null; + 'name': string; /** * Color of the Environment. * @type {string} diff --git a/model/index.ts b/model/index.ts index 8f7318d..276ad30 100644 --- a/model/index.ts +++ b/model/index.ts @@ -56,6 +56,7 @@ export * from './modify-integration-request'; export * from './operation-type'; export * from './organization-admin-model'; export * from './organization-invitation-model'; +export * from './organization-limitations'; export * from './organization-member-model'; export * from './organization-members-model'; export * from './organization-model'; @@ -64,9 +65,13 @@ export * from './organization-permission-model'; export * from './organization-product-model'; export * from './percentage-option-model'; export * from './permission-group-model'; +export * from './predefined-variation-environment-model'; export * from './predefined-variation-model'; +export * from './predefined-variation-usage-model'; export * from './predefined-variation-value-model'; +export * from './predefined-variation-with-usages-model'; export * from './predefined-variations-model'; +export * from './predefined-variations-with-usages-model'; export * from './preferences-model'; export * from './prerequisite-comparator'; export * from './prerequisite-flag-condition-model'; diff --git a/model/organization-limitations.ts b/model/organization-limitations.ts new file mode 100644 index 0000000..5975160 --- /dev/null +++ b/model/organization-limitations.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 OrganizationLimitations + */ +export interface OrganizationLimitations { + /** + * Maximum number of percentage options a Feature Flag or Setting can have within a targeting rule. + * @type {number} + * @memberof OrganizationLimitations + */ + 'maxPercentageOptionCount': number; + /** + * Maximum number of targeting rules a Feature Flag or Setting can have. + * @type {number} + * @memberof OrganizationLimitations + */ + 'maxTargetingRuleCount': number; + /** + * Maximum length of a text comparison value. + * @type {number} + * @memberof OrganizationLimitations + */ + 'maxComparisonValueLength': number; + /** + * Maximum item count of a list comparison value. + * @type {number} + * @memberof OrganizationLimitations + */ + 'maxComparisonValueListLength': number; + /** + * Maximum length of a list comparison value\'s item. + * @type {number} + * @memberof OrganizationLimitations + */ + 'maxComparisonValueListItemLength': number; + /** + * Maximum length of a text Setting\'s value. + * @type {number} + * @memberof OrganizationLimitations + */ + 'maxStringFlagValueLength': number; + /** + * Maximum number of `AND` conditions a Feature Flag or Setting can have within a targeting rule. + * @type {number} + * @memberof OrganizationLimitations + */ + 'maxConditionPerTargetingRuleCount': number; + /** + * The maximum number of predefined variations allowed for a Feature Flag or Setting. + * @type {number} + * @memberof OrganizationLimitations + */ + 'maxPredefinedVariations': number; +} + diff --git a/model/predefined-variation-environment-model.ts b/model/predefined-variation-environment-model.ts new file mode 100644 index 0000000..cb1c282 --- /dev/null +++ b/model/predefined-variation-environment-model.ts @@ -0,0 +1,47 @@ +/* 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 { EnvironmentAccessType } from './environment-access-type'; + +/** + * + * @export + * @interface PredefinedVariationEnvironmentModel + */ +export interface PredefinedVariationEnvironmentModel { + /** + * The identifier of the Environment. + * @type {string} + * @memberof PredefinedVariationEnvironmentModel + */ + 'environmentId': string; + /** + * The name of the Environment. + * @type {string} + * @memberof PredefinedVariationEnvironmentModel + */ + 'name': string; + /** + * + * @type {EnvironmentAccessType} + * @memberof PredefinedVariationEnvironmentModel + */ + 'accessType': EnvironmentAccessType; +} + + + diff --git a/model/predefined-variation-usage-model.ts b/model/predefined-variation-usage-model.ts new file mode 100644 index 0000000..456e24f --- /dev/null +++ b/model/predefined-variation-usage-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 PredefinedVariationUsageModel + */ +export interface PredefinedVariationUsageModel { + /** + * + * @type {number} + * @memberof PredefinedVariationUsageModel + */ + 'settingId': number; + /** + * + * @type {string} + * @memberof PredefinedVariationUsageModel + */ + 'environmentId': string; +} + diff --git a/model/predefined-variation-with-usages-model.ts b/model/predefined-variation-with-usages-model.ts new file mode 100644 index 0000000..04f2710 --- /dev/null +++ b/model/predefined-variation-with-usages-model.ts @@ -0,0 +1,66 @@ +/* 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 { PredefinedVariationUsageModel } from './predefined-variation-usage-model'; +// May contain unused imports in some cases +// @ts-ignore +import { PredefinedVariationValueModel } from './predefined-variation-value-model'; + +/** + * + * @export + * @interface PredefinedVariationWithUsagesModel + */ +export interface PredefinedVariationWithUsagesModel { + /** + * + * @type {PredefinedVariationValueModel} + * @memberof PredefinedVariationWithUsagesModel + */ + 'value': PredefinedVariationValueModel; + /** + * The name of the Feature Flag or Predefined Variation, shown on the Dashboard UI. If not set, the Value will be shown. + * @type {string} + * @memberof PredefinedVariationWithUsagesModel + */ + 'name': string | null; + /** + * The name of the Feature Flag or Predefined Variation, shown on the Dashboard UI. If not set, the Value will be shown. + * @type {string} + * @memberof PredefinedVariationWithUsagesModel + */ + 'hint': string | null; + /** + * The Feature Flag or Predefined Variation\'s identifier. + * @type {string} + * @memberof PredefinedVariationWithUsagesModel + */ + 'predefinedVariationId': string; + /** + * The Feature Flag or Setting Variation\'s usages in the given Environments. + * @type {Array} + * @memberof PredefinedVariationWithUsagesModel + */ + 'usages': Array; + /** + * The Feature Flag or Setting Variation\'s usages in the Environments you don\'t have access to. + * @type {number} + * @memberof PredefinedVariationWithUsagesModel + */ + 'usagesInOtherEnvironments': number; +} + diff --git a/model/predefined-variations-with-usages-model.ts b/model/predefined-variations-with-usages-model.ts new file mode 100644 index 0000000..ee7947a --- /dev/null +++ b/model/predefined-variations-with-usages-model.ts @@ -0,0 +1,65 @@ +/* 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 { PredefinedVariationEnvironmentModel } from './predefined-variation-environment-model'; +// May contain unused imports in some cases +// @ts-ignore +import { PredefinedVariationWithUsagesModel } from './predefined-variation-with-usages-model'; +// May contain unused imports in some cases +// @ts-ignore +import { SettingType } from './setting-type'; + +/** + * + * @export + * @interface PredefinedVariationsWithUsagesModel + */ +export interface PredefinedVariationsWithUsagesModel { + /** + * Key of the Feature Flag or Setting. + * @type {string} + * @memberof PredefinedVariationsWithUsagesModel + */ + 'settingKey': string; + /** + * + * @type {SettingType} + * @memberof PredefinedVariationsWithUsagesModel + */ + 'settingType': SettingType; + /** + * The Feature Flag or Setting\'s Variations. + * @type {Array} + * @memberof PredefinedVariationsWithUsagesModel + */ + 'predefinedVariations': Array; + /** + * The Environment descriptors for the Variations\' usages. + * @type {Array} + * @memberof PredefinedVariationsWithUsagesModel + */ + 'environments': Array; + /** + * The maximum number of predefined variations allowed for the Feature Flag or Setting. + * @type {number} + * @memberof PredefinedVariationsWithUsagesModel + */ + 'maxPredefinedVariations': number; +} + + + diff --git a/package-lock.json b/package-lock.json index 951e0a4..7dc230d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "configcat-publicapi-node-client", - "version": "3.1.1", + "version": "3.2.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "configcat-publicapi-node-client", - "version": "3.1.1", + "version": "3.2.0", "dependencies": { "axios": "^1.6.7", "bluebird": "^3.5.0" diff --git a/package.json b/package.json index c4427d7..4191c94 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "configcat-publicapi-node-client", - "version": "3.1.1", + "version": "3.2.0", "description": "NodeJS client for configcat-publicapi-node-client", "main": "dist/index.js", "types": "dist/index.d.ts",