@flagpole/api-types 1.0.27 → 1.0.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/lib/flagpole-api-types.d.ts +131 -5
- package/lib/flagpole-api-types.js +53 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
# @flagpole/api-types v1.0.
|
|
1
|
+
# @flagpole/api-types v1.0.29
|
|
2
2
|
TypeScript types for FlagPole API generated from OpenAPI specification.
|
|
@@ -30,7 +30,7 @@ export interface ActivityLogControllerGetOrganizationActivitiesParams {
|
|
|
30
30
|
skip?: number;
|
|
31
31
|
projectId?: string;
|
|
32
32
|
entityType?: "feature_flag" | "project";
|
|
33
|
-
action?: "feature_flag.created" | "feature_flag.updated" | "feature_flag.toggled" | "feature_flag.deleted" | "project.created" | "project.updated" | "project.member_added" | "project.member_removed" | "project.member_role_changed" | "project.deleted";
|
|
33
|
+
action?: "feature_flag.created" | "feature_flag.updated" | "feature_flag.toggled" | "feature_flag.deleted" | "project.created" | "project.updated" | "project.member_added" | "project.member_removed" | "project.member_role_changed" | "project.deleted" | "project.environment_added" | "project.environment_updated" | "project.environment_removed";
|
|
34
34
|
}
|
|
35
35
|
export type ActivityLogControllerGetProjectActivitiesData = any;
|
|
36
36
|
export interface ActivityLogControllerGetProjectActivitiesParams {
|
|
@@ -181,7 +181,11 @@ export interface CreateFeatureFlagDto {
|
|
|
181
181
|
* @example "Enables dark mode UI"
|
|
182
182
|
*/
|
|
183
183
|
description: string;
|
|
184
|
-
|
|
184
|
+
/**
|
|
185
|
+
* Environment keys (from the project's environment list) where this flag is active
|
|
186
|
+
* @example ["development","staging"]
|
|
187
|
+
*/
|
|
188
|
+
environments?: any[][];
|
|
185
189
|
/**
|
|
186
190
|
* Whether the flag is initially enabled
|
|
187
191
|
* @default false
|
|
@@ -223,6 +227,17 @@ export interface CreateProjectDto {
|
|
|
223
227
|
*/
|
|
224
228
|
name: string;
|
|
225
229
|
}
|
|
230
|
+
export interface CreateProjectEnvironmentDto {
|
|
231
|
+
/** @example "#2563c9" */
|
|
232
|
+
color?: string;
|
|
233
|
+
/**
|
|
234
|
+
* Stable key used by SDKs and API keys
|
|
235
|
+
* @example "sit1"
|
|
236
|
+
*/
|
|
237
|
+
key: string;
|
|
238
|
+
/** @example "SIT — Acme Corp" */
|
|
239
|
+
name: string;
|
|
240
|
+
}
|
|
226
241
|
export interface DemoRequestDto {
|
|
227
242
|
/**
|
|
228
243
|
* Company name
|
|
@@ -245,8 +260,6 @@ export interface DemoRequestDto {
|
|
|
245
260
|
*/
|
|
246
261
|
notes?: string;
|
|
247
262
|
}
|
|
248
|
-
/** Environments where this flag is active */
|
|
249
|
-
export type Environment = "development" | "staging" | "production";
|
|
250
263
|
export type FeatureFlag = object;
|
|
251
264
|
export interface FeatureFlagConditionDto {
|
|
252
265
|
/** Rules for the condition */
|
|
@@ -368,10 +381,19 @@ export interface ProductWithFeaturesDto {
|
|
|
368
381
|
name: string;
|
|
369
382
|
prices: ProductPriceDto[];
|
|
370
383
|
}
|
|
384
|
+
export type ProjectsControllerAddEnvironmentData = any;
|
|
371
385
|
export type ProjectsControllerCreateData = any;
|
|
372
386
|
export type ProjectsControllerDeleteData = any;
|
|
373
387
|
export type ProjectsControllerFindAllData = any;
|
|
388
|
+
export type ProjectsControllerGetEnvironmentsData = any;
|
|
389
|
+
export type ProjectsControllerRemoveEnvironmentData = any;
|
|
390
|
+
export interface ProjectsControllerRemoveEnvironmentParams {
|
|
391
|
+
force: string;
|
|
392
|
+
id: string;
|
|
393
|
+
key: string;
|
|
394
|
+
}
|
|
374
395
|
export type ProjectsControllerUpdateData = any;
|
|
396
|
+
export type ProjectsControllerUpdateEnvironmentData = any;
|
|
375
397
|
export interface ResetPasswordDto {
|
|
376
398
|
/**
|
|
377
399
|
* New password
|
|
@@ -420,6 +442,14 @@ export interface UpdateProjectDto {
|
|
|
420
442
|
*/
|
|
421
443
|
name: string;
|
|
422
444
|
}
|
|
445
|
+
export interface UpdateProjectEnvironmentDto {
|
|
446
|
+
/** Archive or restore the environment */
|
|
447
|
+
archived?: boolean;
|
|
448
|
+
/** @example "#2563c9" */
|
|
449
|
+
color?: string;
|
|
450
|
+
/** @example "SIT — Acme Corp" */
|
|
451
|
+
name?: string;
|
|
452
|
+
}
|
|
423
453
|
export interface UpdateUserDto {
|
|
424
454
|
/** User first name */
|
|
425
455
|
firstName?: string;
|
|
@@ -709,7 +739,7 @@ export declare namespace Api {
|
|
|
709
739
|
skip?: number;
|
|
710
740
|
projectId?: string;
|
|
711
741
|
entityType?: "feature_flag" | "project";
|
|
712
|
-
action?: "feature_flag.created" | "feature_flag.updated" | "feature_flag.toggled" | "feature_flag.deleted" | "project.created" | "project.updated" | "project.member_added" | "project.member_removed" | "project.member_role_changed" | "project.deleted";
|
|
742
|
+
action?: "feature_flag.created" | "feature_flag.updated" | "feature_flag.toggled" | "feature_flag.deleted" | "project.created" | "project.updated" | "project.member_added" | "project.member_removed" | "project.member_role_changed" | "project.deleted" | "project.environment_added" | "project.environment_updated" | "project.environment_removed";
|
|
713
743
|
};
|
|
714
744
|
type RequestBody = never;
|
|
715
745
|
type RequestHeaders = {
|
|
@@ -1115,6 +1145,70 @@ export declare namespace Api {
|
|
|
1115
1145
|
type RequestHeaders = {};
|
|
1116
1146
|
type ResponseBody = ProjectsControllerDeleteData;
|
|
1117
1147
|
}
|
|
1148
|
+
/**
|
|
1149
|
+
* No description
|
|
1150
|
+
* @name ProjectsControllerGetEnvironments
|
|
1151
|
+
* @request GET:/api/projects/{id}/environments
|
|
1152
|
+
* @response `200` `ProjectsControllerGetEnvironmentsData`
|
|
1153
|
+
*/
|
|
1154
|
+
namespace ProjectsControllerGetEnvironments {
|
|
1155
|
+
type RequestParams = {
|
|
1156
|
+
id: string;
|
|
1157
|
+
};
|
|
1158
|
+
type RequestQuery = {};
|
|
1159
|
+
type RequestBody = never;
|
|
1160
|
+
type RequestHeaders = {};
|
|
1161
|
+
type ResponseBody = ProjectsControllerGetEnvironmentsData;
|
|
1162
|
+
}
|
|
1163
|
+
/**
|
|
1164
|
+
* No description
|
|
1165
|
+
* @name ProjectsControllerAddEnvironment
|
|
1166
|
+
* @request POST:/api/projects/{id}/environments
|
|
1167
|
+
* @response `201` `ProjectsControllerAddEnvironmentData`
|
|
1168
|
+
*/
|
|
1169
|
+
namespace ProjectsControllerAddEnvironment {
|
|
1170
|
+
type RequestParams = {
|
|
1171
|
+
id: string;
|
|
1172
|
+
};
|
|
1173
|
+
type RequestQuery = {};
|
|
1174
|
+
type RequestBody = CreateProjectEnvironmentDto;
|
|
1175
|
+
type RequestHeaders = {};
|
|
1176
|
+
type ResponseBody = ProjectsControllerAddEnvironmentData;
|
|
1177
|
+
}
|
|
1178
|
+
/**
|
|
1179
|
+
* No description
|
|
1180
|
+
* @name ProjectsControllerUpdateEnvironment
|
|
1181
|
+
* @request PATCH:/api/projects/{id}/environments/{key}
|
|
1182
|
+
* @response `200` `ProjectsControllerUpdateEnvironmentData`
|
|
1183
|
+
*/
|
|
1184
|
+
namespace ProjectsControllerUpdateEnvironment {
|
|
1185
|
+
type RequestParams = {
|
|
1186
|
+
id: string;
|
|
1187
|
+
key: string;
|
|
1188
|
+
};
|
|
1189
|
+
type RequestQuery = {};
|
|
1190
|
+
type RequestBody = UpdateProjectEnvironmentDto;
|
|
1191
|
+
type RequestHeaders = {};
|
|
1192
|
+
type ResponseBody = ProjectsControllerUpdateEnvironmentData;
|
|
1193
|
+
}
|
|
1194
|
+
/**
|
|
1195
|
+
* No description
|
|
1196
|
+
* @name ProjectsControllerRemoveEnvironment
|
|
1197
|
+
* @request DELETE:/api/projects/{id}/environments/{key}
|
|
1198
|
+
* @response `200` `ProjectsControllerRemoveEnvironmentData`
|
|
1199
|
+
*/
|
|
1200
|
+
namespace ProjectsControllerRemoveEnvironment {
|
|
1201
|
+
type RequestParams = {
|
|
1202
|
+
id: string;
|
|
1203
|
+
key: string;
|
|
1204
|
+
};
|
|
1205
|
+
type RequestQuery = {
|
|
1206
|
+
force: string;
|
|
1207
|
+
};
|
|
1208
|
+
type RequestBody = never;
|
|
1209
|
+
type RequestHeaders = {};
|
|
1210
|
+
type ResponseBody = ProjectsControllerRemoveEnvironmentData;
|
|
1211
|
+
}
|
|
1118
1212
|
/**
|
|
1119
1213
|
* No description
|
|
1120
1214
|
* @name FeedbackControllerSubmit
|
|
@@ -1796,6 +1890,38 @@ export declare class Api<SecurityDataType extends unknown> {
|
|
|
1796
1890
|
* @response `200` `ProjectsControllerDeleteData`
|
|
1797
1891
|
*/
|
|
1798
1892
|
projectsControllerDelete: (id: string, params?: RequestParams) => Promise<AxiosResponse<any, any, {}, any>>;
|
|
1893
|
+
/**
|
|
1894
|
+
* No description
|
|
1895
|
+
*
|
|
1896
|
+
* @name ProjectsControllerGetEnvironments
|
|
1897
|
+
* @request GET:/api/projects/{id}/environments
|
|
1898
|
+
* @response `200` `ProjectsControllerGetEnvironmentsData`
|
|
1899
|
+
*/
|
|
1900
|
+
projectsControllerGetEnvironments: (id: string, params?: RequestParams) => Promise<AxiosResponse<any, any, {}, any>>;
|
|
1901
|
+
/**
|
|
1902
|
+
* No description
|
|
1903
|
+
*
|
|
1904
|
+
* @name ProjectsControllerAddEnvironment
|
|
1905
|
+
* @request POST:/api/projects/{id}/environments
|
|
1906
|
+
* @response `201` `ProjectsControllerAddEnvironmentData`
|
|
1907
|
+
*/
|
|
1908
|
+
projectsControllerAddEnvironment: (id: string, data: CreateProjectEnvironmentDto, params?: RequestParams) => Promise<AxiosResponse<any, any, {}, any>>;
|
|
1909
|
+
/**
|
|
1910
|
+
* No description
|
|
1911
|
+
*
|
|
1912
|
+
* @name ProjectsControllerUpdateEnvironment
|
|
1913
|
+
* @request PATCH:/api/projects/{id}/environments/{key}
|
|
1914
|
+
* @response `200` `ProjectsControllerUpdateEnvironmentData`
|
|
1915
|
+
*/
|
|
1916
|
+
projectsControllerUpdateEnvironment: (id: string, key: string, data: UpdateProjectEnvironmentDto, params?: RequestParams) => Promise<AxiosResponse<any, any, {}, any>>;
|
|
1917
|
+
/**
|
|
1918
|
+
* No description
|
|
1919
|
+
*
|
|
1920
|
+
* @name ProjectsControllerRemoveEnvironment
|
|
1921
|
+
* @request DELETE:/api/projects/{id}/environments/{key}
|
|
1922
|
+
* @response `200` `ProjectsControllerRemoveEnvironmentData`
|
|
1923
|
+
*/
|
|
1924
|
+
projectsControllerRemoveEnvironment: ({ id, key, ...query }: ProjectsControllerRemoveEnvironmentParams, params?: RequestParams) => Promise<AxiosResponse<any, any, {}, any>>;
|
|
1799
1925
|
/**
|
|
1800
1926
|
* No description
|
|
1801
1927
|
*
|
|
@@ -706,6 +706,59 @@ class Api {
|
|
|
706
706
|
method: "DELETE",
|
|
707
707
|
...params,
|
|
708
708
|
}),
|
|
709
|
+
/**
|
|
710
|
+
* No description
|
|
711
|
+
*
|
|
712
|
+
* @name ProjectsControllerGetEnvironments
|
|
713
|
+
* @request GET:/api/projects/{id}/environments
|
|
714
|
+
* @response `200` `ProjectsControllerGetEnvironmentsData`
|
|
715
|
+
*/
|
|
716
|
+
projectsControllerGetEnvironments: (id, params = {}) => this.http.request({
|
|
717
|
+
path: `/api/projects/${id}/environments`,
|
|
718
|
+
method: "GET",
|
|
719
|
+
...params,
|
|
720
|
+
}),
|
|
721
|
+
/**
|
|
722
|
+
* No description
|
|
723
|
+
*
|
|
724
|
+
* @name ProjectsControllerAddEnvironment
|
|
725
|
+
* @request POST:/api/projects/{id}/environments
|
|
726
|
+
* @response `201` `ProjectsControllerAddEnvironmentData`
|
|
727
|
+
*/
|
|
728
|
+
projectsControllerAddEnvironment: (id, data, params = {}) => this.http.request({
|
|
729
|
+
path: `/api/projects/${id}/environments`,
|
|
730
|
+
method: "POST",
|
|
731
|
+
body: data,
|
|
732
|
+
type: ContentType.Json,
|
|
733
|
+
...params,
|
|
734
|
+
}),
|
|
735
|
+
/**
|
|
736
|
+
* No description
|
|
737
|
+
*
|
|
738
|
+
* @name ProjectsControllerUpdateEnvironment
|
|
739
|
+
* @request PATCH:/api/projects/{id}/environments/{key}
|
|
740
|
+
* @response `200` `ProjectsControllerUpdateEnvironmentData`
|
|
741
|
+
*/
|
|
742
|
+
projectsControllerUpdateEnvironment: (id, key, data, params = {}) => this.http.request({
|
|
743
|
+
path: `/api/projects/${id}/environments/${key}`,
|
|
744
|
+
method: "PATCH",
|
|
745
|
+
body: data,
|
|
746
|
+
type: ContentType.Json,
|
|
747
|
+
...params,
|
|
748
|
+
}),
|
|
749
|
+
/**
|
|
750
|
+
* No description
|
|
751
|
+
*
|
|
752
|
+
* @name ProjectsControllerRemoveEnvironment
|
|
753
|
+
* @request DELETE:/api/projects/{id}/environments/{key}
|
|
754
|
+
* @response `200` `ProjectsControllerRemoveEnvironmentData`
|
|
755
|
+
*/
|
|
756
|
+
projectsControllerRemoveEnvironment: ({ id, key, ...query }, params = {}) => this.http.request({
|
|
757
|
+
path: `/api/projects/${id}/environments/${key}`,
|
|
758
|
+
method: "DELETE",
|
|
759
|
+
query: query,
|
|
760
|
+
...params,
|
|
761
|
+
}),
|
|
709
762
|
/**
|
|
710
763
|
* No description
|
|
711
764
|
*
|