/** * Harness feature flag service client apis * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * Contact: cf@harness.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * * @export * @interface AuthenticationRequest */ export interface AuthenticationRequest { /** * * @type {string} * @memberof AuthenticationRequest */ apiKey: string; /** * * @type {AuthenticationRequestTarget} * @memberof AuthenticationRequest */ target?: AuthenticationRequestTarget; } /** * * @export * @interface AuthenticationRequestTarget */ export interface AuthenticationRequestTarget { /** * * @type {string} * @memberof AuthenticationRequestTarget */ identifier: string; /** * * @type {string} * @memberof AuthenticationRequestTarget */ name?: string; /** * * @type {boolean} * @memberof AuthenticationRequestTarget */ anonymous?: boolean; /** * * @type {object} * @memberof AuthenticationRequestTarget */ attributes?: object; } /** * * @export * @interface AuthenticationResponse */ export interface AuthenticationResponse { /** * * @type {string} * @memberof AuthenticationResponse */ authToken: string; } /** * A clause describes what conditions are used to evaluate a flag * @export * @interface Clause */ export interface Clause { /** * The unique ID for the clause * @type {string} * @memberof Clause */ id?: string; /** * The attribute to use in the clause. This can be any target attribute * @type {string} * @memberof Clause */ attribute: string; /** * The type of operation such as equals, starts_with, contains * @type {string} * @memberof Clause */ op: string; /** * The values that are compared against the operator * @type {Array} * @memberof Clause */ values: Array; /** * Is the operation negated? * @type {boolean} * @memberof Clause */ negate: boolean; } /** * Describes a distribution rule * @export * @interface Distribution */ export interface Distribution { /** * The attribute to use when distributing targets across buckets * @type {string} * @memberof Distribution */ bucketBy: string; /** * A list of variations and the weight that should be given to each * @type {Array} * @memberof Distribution */ variations: Array; } /** * * @export * @interface Evaluation */ export interface Evaluation { /** * * @type {string} * @memberof Evaluation */ flag: string; /** * * @type {string} * @memberof Evaluation */ value: string; /** * * @type {string} * @memberof Evaluation */ kind: string; /** * * @type {string} * @memberof Evaluation */ identifier?: string; } /** * * @export * @interface FeatureConfig */ export interface FeatureConfig { /** * * @type {string} * @memberof FeatureConfig */ project: string; /** * * @type {string} * @memberof FeatureConfig */ environment: string; /** * * @type {string} * @memberof FeatureConfig */ feature: string; /** * * @type {FeatureState} * @memberof FeatureConfig */ state: FeatureState; /** * * @type {string} * @memberof FeatureConfig */ kind: FeatureConfigKindEnum; /** * * @type {Array} * @memberof FeatureConfig */ variations: Array; /** * * @type {Array} * @memberof FeatureConfig */ rules?: Array; /** * * @type {Serve} * @memberof FeatureConfig */ defaultServe: Serve; /** * * @type {string} * @memberof FeatureConfig */ offVariation: string; /** * * @type {Array} * @memberof FeatureConfig */ prerequisites?: Array; /** * * @type {Array} * @memberof FeatureConfig */ variationToTargetMap?: Array; /** * * @type {number} * @memberof FeatureConfig */ version?: number; } /** * @export * @enum {string} */ export declare enum FeatureConfigKindEnum { Boolean = "boolean", Int = "int", String = "string", Json = "json" } /** * The state of a flag either off or on * @export * @enum {string} */ export declare enum FeatureState { On = "on", Off = "off" } /** * The rule used to determine what variation to serve to a target * @export * @interface GroupServingRule */ export interface GroupServingRule { /** * The unique identifier for this rule * @type {string} * @memberof GroupServingRule */ ruleId: string; /** * The rules priority relative to other rules. The rules are evaluated in order with 1 being the highest * @type {number} * @memberof GroupServingRule */ priority: number; /** * A list of clauses to use in the rule * @type {Array} * @memberof GroupServingRule */ clauses: Array; } /** * * @export * @interface InlineObject */ export interface InlineObject { /** * * @type {string} * @memberof InlineObject */ proxyKey: string; } /** * * @export * @interface KeyValue */ export interface KeyValue { /** * * @type {string} * @memberof KeyValue */ key: string; /** * * @type {string} * @memberof KeyValue */ value: string; } /** * * @export * @interface Metrics */ export interface Metrics { /** * * @type {Array} * @memberof Metrics */ targetData?: Array; /** * * @type {Array} * @memberof Metrics */ metricsData?: Array; } /** * * @export * @interface MetricsData */ export interface MetricsData { /** * time at when this data was recorded * @type {number} * @memberof MetricsData */ timestamp: number; /** * * @type {number} * @memberof MetricsData */ count: number; /** * This can be of type FeatureMetrics * @type {string} * @memberof MetricsData */ metricsType: MetricsDataMetricsTypeEnum; /** * * @type {Array} * @memberof MetricsData */ attributes: Array; } /** * @export * @enum {string} */ export declare enum MetricsDataMetricsTypeEnum { Ffmetrics = "FFMETRICS" } /** * * @export * @interface ModelError */ export interface ModelError { /** * The http error code * @type {string} * @memberof ModelError */ code: string; /** * The reason the request failed * @type {string} * @memberof ModelError */ message: string; /** * Additional details about the error * @type {object} * @memberof ModelError */ details?: object; } /** * * @export * @interface Pagination */ export interface Pagination { /** * The version of this object. The version will be incremented each time the object is modified * @type {number} * @memberof Pagination */ version?: number; /** * The total number of pages * @type {number} * @memberof Pagination */ pageCount: number; /** * The total number of items * @type {number} * @memberof Pagination */ itemCount: number; /** * The number of items per page * @type {number} * @memberof Pagination */ pageSize: number; /** * The current page * @type {number} * @memberof Pagination */ pageIndex: number; } /** * Feature Flag pre-requisites * @export * @interface Prerequisite */ export interface Prerequisite { /** * The feature identifier that is the prerequisite * @type {string} * @memberof Prerequisite */ feature: string; /** * A list of variations that must be met * @type {Array} * @memberof Prerequisite */ variations: Array; } /** * TBD * @export * @interface ProxyConfig */ export interface ProxyConfig { /** * The version of this object. The version will be incremented each time the object is modified * @type {number} * @memberof ProxyConfig */ version?: number; /** * The total number of pages * @type {number} * @memberof ProxyConfig */ pageCount: number; /** * The total number of items * @type {number} * @memberof ProxyConfig */ itemCount: number; /** * The number of items per page * @type {number} * @memberof ProxyConfig */ pageSize: number; /** * The current page * @type {number} * @memberof ProxyConfig */ pageIndex: number; /** * * @type {Array} * @memberof ProxyConfig */ environments?: Array; } /** * * @export * @interface ProxyConfigAllOf */ export interface ProxyConfigAllOf { /** * * @type {Array} * @memberof ProxyConfigAllOf */ environments?: Array; } /** * * @export * @interface ProxyConfigAllOfEnvironments */ export interface ProxyConfigAllOfEnvironments { /** * * @type {string} * @memberof ProxyConfigAllOfEnvironments */ id?: string; /** * * @type {Array} * @memberof ProxyConfigAllOfEnvironments */ apiKeys?: Array; /** * * @type {Array} * @memberof ProxyConfigAllOfEnvironments */ featureConfigs?: Array; /** * * @type {Array} * @memberof ProxyConfigAllOfEnvironments */ segments?: Array; } /** * A Target Group (Segment) response * @export * @interface Segment */ export interface Segment { /** * Unique identifier for the target group. * @type {string} * @memberof Segment */ identifier: string; /** * Name of the target group. * @type {string} * @memberof Segment */ name: string; /** * The environment this target group belongs to * @type {string} * @memberof Segment */ environment?: string; /** * Tags for this target group * @type {Array} * @memberof Segment */ tags?: Array; /** * A list of Targets who belong to this target group * @type {Array} * @memberof Segment */ included?: Array; /** * A list of Targets who are excluded from this target group * @type {Array} * @memberof Segment */ excluded?: Array; /** * * @type {Array} * @memberof Segment */ rules?: Array; /** * An array of rules that can cause a user to be included in this segment. * @type {Array} * @memberof Segment */ servingRules?: Array; /** * The data and time in milliseconds when the group was created * @type {number} * @memberof Segment */ createdAt?: number; /** * The data and time in milliseconds when the group was last modified * @type {number} * @memberof Segment */ modifiedAt?: number; /** * The version of this group. Each time it is modified the version is incremented * @type {number} * @memberof Segment */ version?: number; } /** * Describe the distribution rule and the variation that should be served to the target * @export * @interface Serve */ export interface Serve { /** * * @type {Distribution} * @memberof Serve */ distribution?: Distribution; /** * * @type {string} * @memberof Serve */ variation?: string; } /** * The rule used to determine what variation to serve to a target * @export * @interface ServingRule */ export interface ServingRule { /** * The unique identifier for this rule * @type {string} * @memberof ServingRule */ ruleId?: string; /** * The rules priority relative to other rules. The rules are evaluated in order with 1 being the highest * @type {number} * @memberof ServingRule */ priority: number; /** * A list of clauses to use in the rule * @type {Array} * @memberof ServingRule */ clauses: Array; /** * * @type {Serve} * @memberof ServingRule */ serve: Serve; } /** * A Tag object used to tag feature flags - consists of name and identifier * @export * @interface Tag */ export interface Tag { /** * The name of the tag * @type {string} * @memberof Tag */ name: string; /** * The identifier of the tag * @type {string} * @memberof Tag */ identifier: string; } /** * A Target object * @export * @interface Target */ export interface Target { /** * The unique identifier for this target * @type {string} * @memberof Target */ identifier: string; /** * The account ID that the target belongs to * @type {string} * @memberof Target */ account: string; /** * The identifier for the organization that the target belongs to * @type {string} * @memberof Target */ org: string; /** * The identifier for the environment that the target belongs to * @type {string} * @memberof Target */ environment: string; /** * The identifier for the project that this target belongs to * @type {string} * @memberof Target */ project: string; /** * The name of this Target * @type {string} * @memberof Target */ name: string; /** * Indicates if this target is anonymous * @type {boolean} * @memberof Target */ anonymous?: boolean; /** * a JSON representation of the attributes for this target * @type {object} * @memberof Target */ attributes?: object; /** * The date and time in milliseconds when this Target was created * @type {number} * @memberof Target */ createdAt?: number; /** * A list of Target Groups (Segments) that this Target belongs to * @type {Array} * @memberof Target */ segments?: Array; } /** * * @export * @interface TargetData */ export interface TargetData { /** * * @type {string} * @memberof TargetData */ identifier: string; /** * * @type {string} * @memberof TargetData */ name: string; /** * * @type {Array} * @memberof TargetData */ attributes: Array; } /** * Target map provides the details of a target that belongs to a flag * @export * @interface TargetMap */ export interface TargetMap { /** * The identifier for the target * @type {string} * @memberof TargetMap */ identifier: string; /** * The name of the target * @type {string} * @memberof TargetMap */ name: string; } /** * A variation of a flag that can be returned to a target * @export * @interface Variation */ export interface Variation { /** * The unique identifier for the variation * @type {string} * @memberof Variation */ identifier: string; /** * The variation value to serve such as true or false for a boolean flag * @type {string} * @memberof Variation */ value: string; /** * The user friendly name of the variation * @type {string} * @memberof Variation */ name?: string; /** * A description of the variation * @type {string} * @memberof Variation */ description?: string; } /** * A mapping of variations to targets and target groups (segments). The targets listed here should receive this variation. * @export * @interface VariationMap */ export interface VariationMap { /** * The variation identifier * @type {string} * @memberof VariationMap */ variation: string; /** * A list of target mappings * @type {Array} * @memberof VariationMap */ targets?: Array; /** * A list of target groups (segments) * @type {Array} * @memberof VariationMap */ targetSegments?: Array; } /** * A variation and the weighting it should receive as part of a percentage rollout * @export * @interface WeightedVariation */ export interface WeightedVariation { /** * The variation identifier * @type {string} * @memberof WeightedVariation */ variation: string; /** * The weight to be given to the variation in percent * @type {number} * @memberof WeightedVariation */ weight: number; } /** * ClientApi - axios parameter creator * @export */ export declare const ClientApiAxiosParamCreator: (configuration?: Configuration) => { /** * Used to retrieve all target segments for certain account id. * @summary Authenticate with the admin server. * @param {AuthenticationRequest} [authenticationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticate: (authenticationRequest?: AuthenticationRequest, options?: any) => Promise; /** * Used to retrieve all segments for certain account id. * @summary Retrieve all segments. * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [rules] When set to rules=v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllSegments: (environmentUUID: string, cluster?: string, rules?: string, options?: any) => Promise; /** * * @summary Get feature evaluations for target * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} feature Unique identifier for the flag object in the API. * @param {string} target Unique identifier for the target object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvaluationByIdentifier: (environmentUUID: string, feature: string, target: string, cluster?: string, options?: any) => Promise; /** * * @summary Get feature evaluations for target * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} target Unique identifier for the target object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvaluations: (environmentUUID: string, target: string, cluster?: string, options?: any) => Promise; /** * All feature flags with activations in project environment * @summary Get all feature flags activations * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureConfig: (environmentUUID: string, cluster?: string, options?: any) => Promise; /** * * @summary Get feature config * @param {string} identifier Unique identifier for the flag object in the API. * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureConfigByIdentifier: (identifier: string, environmentUUID: string, cluster?: string, options?: any) => Promise; /** * Used to retrieve a segment for a certain account id by identifier * @summary Retrieve a segment by identifier * @param {string} identifier Unique identifier for the segment object in the API * @param {string} environmentUUID Unique identifier for the environment object in the API * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [rules] When set to rules=v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegmentByIdentifier: (identifier: string, environmentUUID: string, cluster?: string, rules?: string, options?: any) => Promise; /** * * @summary Stream endpoint. * @param {string} aPIKey * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ stream: (aPIKey: string, cluster?: string, options?: any) => Promise; }; /** * ClientApi - functional programming interface * @export */ export declare const ClientApiFp: (configuration?: Configuration) => { /** * Used to retrieve all target segments for certain account id. * @summary Authenticate with the admin server. * @param {AuthenticationRequest} [authenticationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticate(authenticationRequest?: AuthenticationRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Used to retrieve all segments for certain account id. * @summary Retrieve all segments. * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [rules] When set to rules=v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllSegments(environmentUUID: string, cluster?: string, rules?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary Get feature evaluations for target * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} feature Unique identifier for the flag object in the API. * @param {string} target Unique identifier for the target object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvaluationByIdentifier(environmentUUID: string, feature: string, target: string, cluster?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get feature evaluations for target * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} target Unique identifier for the target object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvaluations(environmentUUID: string, target: string, cluster?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * All feature flags with activations in project environment * @summary Get all feature flags activations * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureConfig(environmentUUID: string, cluster?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary Get feature config * @param {string} identifier Unique identifier for the flag object in the API. * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureConfigByIdentifier(identifier: string, environmentUUID: string, cluster?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Used to retrieve a segment for a certain account id by identifier * @summary Retrieve a segment by identifier * @param {string} identifier Unique identifier for the segment object in the API * @param {string} environmentUUID Unique identifier for the environment object in the API * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [rules] When set to rules=v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegmentByIdentifier(identifier: string, environmentUUID: string, cluster?: string, rules?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Stream endpoint. * @param {string} aPIKey * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ stream(aPIKey: string, cluster?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ClientApi - factory interface * @export */ export declare const ClientApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Used to retrieve all target segments for certain account id. * @summary Authenticate with the admin server. * @param {AuthenticationRequest} [authenticationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticate(authenticationRequest?: AuthenticationRequest, options?: any): AxiosPromise; /** * Used to retrieve all segments for certain account id. * @summary Retrieve all segments. * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [rules] When set to rules=v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllSegments(environmentUUID: string, cluster?: string, rules?: string, options?: any): AxiosPromise>; /** * * @summary Get feature evaluations for target * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} feature Unique identifier for the flag object in the API. * @param {string} target Unique identifier for the target object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvaluationByIdentifier(environmentUUID: string, feature: string, target: string, cluster?: string, options?: any): AxiosPromise; /** * * @summary Get feature evaluations for target * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} target Unique identifier for the target object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvaluations(environmentUUID: string, target: string, cluster?: string, options?: any): AxiosPromise>; /** * All feature flags with activations in project environment * @summary Get all feature flags activations * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureConfig(environmentUUID: string, cluster?: string, options?: any): AxiosPromise>; /** * * @summary Get feature config * @param {string} identifier Unique identifier for the flag object in the API. * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFeatureConfigByIdentifier(identifier: string, environmentUUID: string, cluster?: string, options?: any): AxiosPromise; /** * Used to retrieve a segment for a certain account id by identifier * @summary Retrieve a segment by identifier * @param {string} identifier Unique identifier for the segment object in the API * @param {string} environmentUUID Unique identifier for the environment object in the API * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [rules] When set to rules=v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSegmentByIdentifier(identifier: string, environmentUUID: string, cluster?: string, rules?: string, options?: any): AxiosPromise; /** * * @summary Stream endpoint. * @param {string} aPIKey * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} */ stream(aPIKey: string, cluster?: string, options?: any): AxiosPromise; }; /** * ClientApi - object-oriented interface * @export * @class ClientApi * @extends {BaseAPI} */ export declare class ClientApi extends BaseAPI { /** * Used to retrieve all target segments for certain account id. * @summary Authenticate with the admin server. * @param {AuthenticationRequest} [authenticationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClientApi */ authenticate(authenticationRequest?: AuthenticationRequest, options?: any): Promise>; /** * Used to retrieve all segments for certain account id. * @summary Retrieve all segments. * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [rules] When set to rules=v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClientApi */ getAllSegments(environmentUUID: string, cluster?: string, rules?: string, options?: any): Promise>; /** * * @summary Get feature evaluations for target * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} feature Unique identifier for the flag object in the API. * @param {string} target Unique identifier for the target object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClientApi */ getEvaluationByIdentifier(environmentUUID: string, feature: string, target: string, cluster?: string, options?: any): Promise>; /** * * @summary Get feature evaluations for target * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} target Unique identifier for the target object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClientApi */ getEvaluations(environmentUUID: string, target: string, cluster?: string, options?: any): Promise>; /** * All feature flags with activations in project environment * @summary Get all feature flags activations * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClientApi */ getFeatureConfig(environmentUUID: string, cluster?: string, options?: any): Promise>; /** * * @summary Get feature config * @param {string} identifier Unique identifier for the flag object in the API. * @param {string} environmentUUID Unique identifier for the environment object in the API. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClientApi */ getFeatureConfigByIdentifier(identifier: string, environmentUUID: string, cluster?: string, options?: any): Promise>; /** * Used to retrieve a segment for a certain account id by identifier * @summary Retrieve a segment by identifier * @param {string} identifier Unique identifier for the segment object in the API * @param {string} environmentUUID Unique identifier for the environment object in the API * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [rules] When set to rules=v2 will return AND rule compatible serving_rules field. When not set or set to any other value will return old rules field only compatible with OR rules. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClientApi */ getSegmentByIdentifier(identifier: string, environmentUUID: string, cluster?: string, rules?: string, options?: any): Promise>; /** * * @summary Stream endpoint. * @param {string} aPIKey * @param {string} [cluster] Unique identifier for the cluster for the account * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClientApi */ stream(aPIKey: string, cluster?: string, options?: any): Promise>; } /** * MetricsApi - axios parameter creator * @export */ export declare const MetricsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Send metrics to Analytics server * @summary Send metrics to the Analytics server. * @param {string} environmentUUID environment parameter in query. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {Metrics} [metrics] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMetrics: (environmentUUID: string, cluster?: string, metrics?: Metrics, options?: any) => Promise; }; /** * MetricsApi - functional programming interface * @export */ export declare const MetricsApiFp: (configuration?: Configuration) => { /** * Send metrics to Analytics server * @summary Send metrics to the Analytics server. * @param {string} environmentUUID environment parameter in query. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {Metrics} [metrics] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMetrics(environmentUUID: string, cluster?: string, metrics?: Metrics, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MetricsApi - factory interface * @export */ export declare const MetricsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Send metrics to Analytics server * @summary Send metrics to the Analytics server. * @param {string} environmentUUID environment parameter in query. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {Metrics} [metrics] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMetrics(environmentUUID: string, cluster?: string, metrics?: Metrics, options?: any): AxiosPromise; }; /** * MetricsApi - object-oriented interface * @export * @class MetricsApi * @extends {BaseAPI} */ export declare class MetricsApi extends BaseAPI { /** * Send metrics to Analytics server * @summary Send metrics to the Analytics server. * @param {string} environmentUUID environment parameter in query. * @param {string} [cluster] Unique identifier for the cluster for the account * @param {Metrics} [metrics] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetricsApi */ postMetrics(environmentUUID: string, cluster?: string, metrics?: Metrics, options?: any): Promise>; } /** * ProxyApi - axios parameter creator * @export */ export declare const ProxyApiAxiosParamCreator: (configuration?: Configuration) => { /** * Endpoint that the Proxy can use to authenticate with the client server * @summary Endpoint that the Proxy can use to authenticate with the client server * @param {InlineObject} [inlineObject] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateProxyKey: (inlineObject?: InlineObject, options?: any) => Promise; /** * Gets Proxy config for multiple environments if the Key query param is provided or gets config for a single environment if an environment query param is provided * @summary Gets Proxy config for multiple environments * @param {string} key Accpets a Proxy Key. * @param {number} [pageNumber] PageNumber * @param {number} [pageSize] PageSize * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [environment] Accepts an EnvironmentID. If this is provided then the endpoint will only return config for this environment. If this is left empty then the Proxy will return config for all environments associated with the Proxy Key. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProxyConfig: (key: string, pageNumber?: number, pageSize?: number, cluster?: string, environment?: string, options?: any) => Promise; }; /** * ProxyApi - functional programming interface * @export */ export declare const ProxyApiFp: (configuration?: Configuration) => { /** * Endpoint that the Proxy can use to authenticate with the client server * @summary Endpoint that the Proxy can use to authenticate with the client server * @param {InlineObject} [inlineObject] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateProxyKey(inlineObject?: InlineObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets Proxy config for multiple environments if the Key query param is provided or gets config for a single environment if an environment query param is provided * @summary Gets Proxy config for multiple environments * @param {string} key Accpets a Proxy Key. * @param {number} [pageNumber] PageNumber * @param {number} [pageSize] PageSize * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [environment] Accepts an EnvironmentID. If this is provided then the endpoint will only return config for this environment. If this is left empty then the Proxy will return config for all environments associated with the Proxy Key. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProxyConfig(key: string, pageNumber?: number, pageSize?: number, cluster?: string, environment?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProxyApi - factory interface * @export */ export declare const ProxyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Endpoint that the Proxy can use to authenticate with the client server * @summary Endpoint that the Proxy can use to authenticate with the client server * @param {InlineObject} [inlineObject] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateProxyKey(inlineObject?: InlineObject, options?: any): AxiosPromise; /** * Gets Proxy config for multiple environments if the Key query param is provided or gets config for a single environment if an environment query param is provided * @summary Gets Proxy config for multiple environments * @param {string} key Accpets a Proxy Key. * @param {number} [pageNumber] PageNumber * @param {number} [pageSize] PageSize * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [environment] Accepts an EnvironmentID. If this is provided then the endpoint will only return config for this environment. If this is left empty then the Proxy will return config for all environments associated with the Proxy Key. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProxyConfig(key: string, pageNumber?: number, pageSize?: number, cluster?: string, environment?: string, options?: any): AxiosPromise; }; /** * ProxyApi - object-oriented interface * @export * @class ProxyApi * @extends {BaseAPI} */ export declare class ProxyApi extends BaseAPI { /** * Endpoint that the Proxy can use to authenticate with the client server * @summary Endpoint that the Proxy can use to authenticate with the client server * @param {InlineObject} [inlineObject] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProxyApi */ authenticateProxyKey(inlineObject?: InlineObject, options?: any): Promise>; /** * Gets Proxy config for multiple environments if the Key query param is provided or gets config for a single environment if an environment query param is provided * @summary Gets Proxy config for multiple environments * @param {string} key Accpets a Proxy Key. * @param {number} [pageNumber] PageNumber * @param {number} [pageSize] PageSize * @param {string} [cluster] Unique identifier for the cluster for the account * @param {string} [environment] Accepts an EnvironmentID. If this is provided then the endpoint will only return config for this environment. If this is left empty then the Proxy will return config for all environments associated with the Proxy Key. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProxyApi */ getProxyConfig(key: string, pageNumber?: number, pageSize?: number, cluster?: string, environment?: string, options?: any): Promise>; }