@envsync-cloud/envsync-ts-sdk 0.1.2 → 0.2.0
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/dist/index.d.mts +179 -51
- package/dist/index.d.ts +179 -51
- package/dist/index.global.js +242 -83
- package/dist/index.js +246 -83
- package/dist/index.mjs +244 -83
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -74,20 +74,12 @@ declare class AccessService {
|
|
|
74
74
|
readonly httpRequest: BaseHttpRequest;
|
|
75
75
|
constructor(httpRequest: BaseHttpRequest);
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* Initiate CLI Login
|
|
78
78
|
* Generate authentication URL for CLI login
|
|
79
|
-
* @returns LoginUrlResponse CLI login
|
|
79
|
+
* @returns LoginUrlResponse CLI login initiated successfully.
|
|
80
80
|
* @throws ApiError
|
|
81
81
|
*/
|
|
82
82
|
createCliLogin(): CancelablePromise<LoginUrlResponse>;
|
|
83
|
-
/**
|
|
84
|
-
* CLI Login Callback
|
|
85
|
-
* Handle CLI login callback from Auth0
|
|
86
|
-
* @param code
|
|
87
|
-
* @returns void
|
|
88
|
-
* @throws ApiError
|
|
89
|
-
*/
|
|
90
|
-
callbackCliLogin(code: string): CancelablePromise<void>;
|
|
91
83
|
/**
|
|
92
84
|
* Create Web Login URL
|
|
93
85
|
* Generate authentication URL for web login
|
|
@@ -120,6 +112,89 @@ declare class AccessService {
|
|
|
120
112
|
callbackApiLogin(code: string): CancelablePromise<CallbackResponse>;
|
|
121
113
|
}
|
|
122
114
|
|
|
115
|
+
type ApiKeyResponse = {
|
|
116
|
+
id: string;
|
|
117
|
+
user_id: string;
|
|
118
|
+
org_id: string;
|
|
119
|
+
description: string;
|
|
120
|
+
is_active: boolean;
|
|
121
|
+
key: string;
|
|
122
|
+
created_at: string;
|
|
123
|
+
updated_at: string;
|
|
124
|
+
last_used_at: string | null;
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
type ApiKeysResponse = Array<ApiKeyResponse>;
|
|
128
|
+
|
|
129
|
+
type CreateApiKeyRequest = {
|
|
130
|
+
name: string;
|
|
131
|
+
description?: string;
|
|
132
|
+
};
|
|
133
|
+
|
|
134
|
+
type RegenerateApiKeyResponse = {
|
|
135
|
+
newKey: string;
|
|
136
|
+
id: string;
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
type UpdateApiKeyRequest = {
|
|
140
|
+
description?: string;
|
|
141
|
+
is_active?: boolean;
|
|
142
|
+
last_used_at?: string;
|
|
143
|
+
};
|
|
144
|
+
|
|
145
|
+
declare class ApiKeysService {
|
|
146
|
+
readonly httpRequest: BaseHttpRequest;
|
|
147
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
148
|
+
/**
|
|
149
|
+
* Create API Key
|
|
150
|
+
* Create a new API key for the organization
|
|
151
|
+
* @param requestBody
|
|
152
|
+
* @returns ApiKeyResponse API key created successfully
|
|
153
|
+
* @throws ApiError
|
|
154
|
+
*/
|
|
155
|
+
createApiKey(requestBody?: CreateApiKeyRequest): CancelablePromise<ApiKeyResponse>;
|
|
156
|
+
/**
|
|
157
|
+
* Get All API Keys
|
|
158
|
+
* Retrieve all API keys for the organization
|
|
159
|
+
* @returns ApiKeysResponse API keys retrieved successfully
|
|
160
|
+
* @throws ApiError
|
|
161
|
+
*/
|
|
162
|
+
getAllApiKeys(): CancelablePromise<ApiKeysResponse>;
|
|
163
|
+
/**
|
|
164
|
+
* Get API Key
|
|
165
|
+
* Retrieve a specific API key
|
|
166
|
+
* @param id
|
|
167
|
+
* @returns ApiKeyResponse API key retrieved successfully
|
|
168
|
+
* @throws ApiError
|
|
169
|
+
*/
|
|
170
|
+
getApiKey(id: string): CancelablePromise<ApiKeyResponse>;
|
|
171
|
+
/**
|
|
172
|
+
* Update API Key
|
|
173
|
+
* Update an existing API key
|
|
174
|
+
* @param id
|
|
175
|
+
* @param requestBody
|
|
176
|
+
* @returns ApiKeyResponse API key updated successfully
|
|
177
|
+
* @throws ApiError
|
|
178
|
+
*/
|
|
179
|
+
updateApiKey(id: string, requestBody?: UpdateApiKeyRequest): CancelablePromise<ApiKeyResponse>;
|
|
180
|
+
/**
|
|
181
|
+
* Delete API Key
|
|
182
|
+
* Delete an existing API key
|
|
183
|
+
* @param id
|
|
184
|
+
* @returns ApiKeyResponse API key deleted successfully
|
|
185
|
+
* @throws ApiError
|
|
186
|
+
*/
|
|
187
|
+
deleteApiKey(id: string): CancelablePromise<ApiKeyResponse>;
|
|
188
|
+
/**
|
|
189
|
+
* Regenerate API Key
|
|
190
|
+
* Generate a new value for an existing API key
|
|
191
|
+
* @param id
|
|
192
|
+
* @returns RegenerateApiKeyResponse API key regenerated successfully
|
|
193
|
+
* @throws ApiError
|
|
194
|
+
*/
|
|
195
|
+
regenerateApiKey(id: string): CancelablePromise<RegenerateApiKeyResponse>;
|
|
196
|
+
}
|
|
197
|
+
|
|
123
198
|
type CreateAppRequest = {
|
|
124
199
|
name: string;
|
|
125
200
|
description: string;
|
|
@@ -275,14 +350,6 @@ declare class AuthenticationService {
|
|
|
275
350
|
whoami(): CancelablePromise<WhoAmIResponse>;
|
|
276
351
|
}
|
|
277
352
|
|
|
278
|
-
type CreateEnvTypeRequest = {
|
|
279
|
-
name: string;
|
|
280
|
-
};
|
|
281
|
-
|
|
282
|
-
type DeleteEnvTypeRequest = {
|
|
283
|
-
id: string;
|
|
284
|
-
};
|
|
285
|
-
|
|
286
353
|
type EnvTypeResponse = {
|
|
287
354
|
id: string;
|
|
288
355
|
name: string;
|
|
@@ -293,11 +360,6 @@ type EnvTypeResponse = {
|
|
|
293
360
|
|
|
294
361
|
type EnvTypesResponse = Array<EnvTypeResponse>;
|
|
295
362
|
|
|
296
|
-
type UpdateEnvTypeRequest = {
|
|
297
|
-
id: string;
|
|
298
|
-
name: string;
|
|
299
|
-
};
|
|
300
|
-
|
|
301
363
|
declare class EnvironmentTypesService {
|
|
302
364
|
readonly httpRequest: BaseHttpRequest;
|
|
303
365
|
constructor(httpRequest: BaseHttpRequest);
|
|
@@ -308,14 +370,6 @@ declare class EnvironmentTypesService {
|
|
|
308
370
|
* @throws ApiError
|
|
309
371
|
*/
|
|
310
372
|
getEnvTypes(): CancelablePromise<EnvTypesResponse>;
|
|
311
|
-
/**
|
|
312
|
-
* Create Environment Type
|
|
313
|
-
* Create a new environment type
|
|
314
|
-
* @param requestBody
|
|
315
|
-
* @returns EnvTypeResponse Environment type created successfully
|
|
316
|
-
* @throws ApiError
|
|
317
|
-
*/
|
|
318
|
-
createEnvType(requestBody?: CreateEnvTypeRequest): CancelablePromise<EnvTypeResponse>;
|
|
319
373
|
/**
|
|
320
374
|
* Get Environment Type
|
|
321
375
|
* Retrieve a specific environment type
|
|
@@ -324,23 +378,6 @@ declare class EnvironmentTypesService {
|
|
|
324
378
|
* @throws ApiError
|
|
325
379
|
*/
|
|
326
380
|
getEnvType(id: string): CancelablePromise<EnvTypeResponse>;
|
|
327
|
-
/**
|
|
328
|
-
* Update Environment Type
|
|
329
|
-
* Update an existing environment type
|
|
330
|
-
* @param id
|
|
331
|
-
* @param requestBody
|
|
332
|
-
* @returns EnvTypeResponse Environment type updated successfully
|
|
333
|
-
* @throws ApiError
|
|
334
|
-
*/
|
|
335
|
-
updateEnvType(id: string, requestBody?: UpdateEnvTypeRequest): CancelablePromise<EnvTypeResponse>;
|
|
336
|
-
/**
|
|
337
|
-
* Delete Environment Type
|
|
338
|
-
* Delete an existing environment type
|
|
339
|
-
* @param id
|
|
340
|
-
* @returns DeleteEnvTypeRequest Environment type deleted successfully
|
|
341
|
-
* @throws ApiError
|
|
342
|
-
*/
|
|
343
|
-
deleteEnvType(id: string): CancelablePromise<DeleteEnvTypeRequest>;
|
|
344
381
|
}
|
|
345
382
|
|
|
346
383
|
type BatchCreateEnvsRequest = {
|
|
@@ -646,14 +683,103 @@ declare class OrganizationsService {
|
|
|
646
683
|
checkIfSlugExists(slug: string): CancelablePromise<CheckSlugResponse>;
|
|
647
684
|
}
|
|
648
685
|
|
|
649
|
-
type
|
|
650
|
-
|
|
686
|
+
type CreateRoleRequest = {
|
|
687
|
+
name: string;
|
|
688
|
+
can_edit: boolean;
|
|
689
|
+
can_view: boolean;
|
|
690
|
+
have_api_access: boolean;
|
|
691
|
+
have_billing_options: boolean;
|
|
692
|
+
have_webhook_access: boolean;
|
|
693
|
+
is_admin: boolean;
|
|
694
|
+
};
|
|
695
|
+
|
|
696
|
+
type RoleResponse = {
|
|
697
|
+
id: string;
|
|
698
|
+
name: string;
|
|
699
|
+
org_id: string;
|
|
700
|
+
can_edit: boolean;
|
|
701
|
+
can_view: boolean;
|
|
702
|
+
have_api_access: boolean;
|
|
703
|
+
have_billing_options: boolean;
|
|
704
|
+
have_webhook_access: boolean;
|
|
705
|
+
is_admin: boolean;
|
|
706
|
+
is_master: boolean;
|
|
707
|
+
created_at: string;
|
|
708
|
+
updated_at: string;
|
|
709
|
+
};
|
|
710
|
+
|
|
711
|
+
type RolesResponse = Array<RoleResponse>;
|
|
712
|
+
|
|
713
|
+
type RoleStatsResponse = {
|
|
714
|
+
admin_access_count: number;
|
|
715
|
+
billing_access_count: number;
|
|
716
|
+
api_access_count: number;
|
|
717
|
+
webhook_access_count: number;
|
|
718
|
+
view_access_count: number;
|
|
719
|
+
edit_access_count: number;
|
|
720
|
+
total_roles: number;
|
|
651
721
|
};
|
|
652
722
|
|
|
653
723
|
type UpdateRoleRequest = {
|
|
654
724
|
role_id: string;
|
|
655
725
|
};
|
|
656
726
|
|
|
727
|
+
declare class RolesService {
|
|
728
|
+
readonly httpRequest: BaseHttpRequest;
|
|
729
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
730
|
+
/**
|
|
731
|
+
* Get All Roles
|
|
732
|
+
* Retrieve all roles in the organization
|
|
733
|
+
* @returns RolesResponse Roles retrieved successfully
|
|
734
|
+
* @throws ApiError
|
|
735
|
+
*/
|
|
736
|
+
getAllRoles(): CancelablePromise<RolesResponse>;
|
|
737
|
+
/**
|
|
738
|
+
* Create Role
|
|
739
|
+
* Create a new role in the organization
|
|
740
|
+
* @param requestBody
|
|
741
|
+
* @returns RoleResponse Role created successfully
|
|
742
|
+
* @throws ApiError
|
|
743
|
+
*/
|
|
744
|
+
createRole(requestBody?: CreateRoleRequest): CancelablePromise<RoleResponse>;
|
|
745
|
+
/**
|
|
746
|
+
* Get Role Statistics
|
|
747
|
+
* Retrieve statistics about roles in the organization
|
|
748
|
+
* @returns RoleStatsResponse Role statistics retrieved successfully
|
|
749
|
+
* @throws ApiError
|
|
750
|
+
*/
|
|
751
|
+
getRoleStats(): CancelablePromise<RoleStatsResponse>;
|
|
752
|
+
/**
|
|
753
|
+
* Get Role
|
|
754
|
+
* Retrieve a specific role by ID
|
|
755
|
+
* @param id
|
|
756
|
+
* @returns RoleResponse Role retrieved successfully
|
|
757
|
+
* @throws ApiError
|
|
758
|
+
*/
|
|
759
|
+
getRole(id: string): CancelablePromise<RoleResponse>;
|
|
760
|
+
/**
|
|
761
|
+
* Update Role
|
|
762
|
+
* Update an existing role
|
|
763
|
+
* @param id
|
|
764
|
+
* @param requestBody
|
|
765
|
+
* @returns RoleResponse Role updated successfully
|
|
766
|
+
* @throws ApiError
|
|
767
|
+
*/
|
|
768
|
+
updateRole(id: string, requestBody?: UpdateRoleRequest): CancelablePromise<RoleResponse>;
|
|
769
|
+
/**
|
|
770
|
+
* Delete Role
|
|
771
|
+
* Delete an existing role (non-master roles only)
|
|
772
|
+
* @param id
|
|
773
|
+
* @returns RoleResponse Role deleted successfully
|
|
774
|
+
* @throws ApiError
|
|
775
|
+
*/
|
|
776
|
+
deleteRole(id: string): CancelablePromise<RoleResponse>;
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
type UpdatePasswordRequest = {
|
|
780
|
+
password: string;
|
|
781
|
+
};
|
|
782
|
+
|
|
657
783
|
type UpdateUserRequest = {
|
|
658
784
|
full_name?: string;
|
|
659
785
|
profile_picture_url?: string;
|
|
@@ -733,6 +859,7 @@ declare class UsersService {
|
|
|
733
859
|
type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
|
|
734
860
|
declare class EnvSyncAPISDK {
|
|
735
861
|
readonly access: AccessService;
|
|
862
|
+
readonly apiKeys: ApiKeysService;
|
|
736
863
|
readonly applications: ApplicationsService;
|
|
737
864
|
readonly auditLogs: AuditLogsService;
|
|
738
865
|
readonly authentication: AuthenticationService;
|
|
@@ -740,6 +867,7 @@ declare class EnvSyncAPISDK {
|
|
|
740
867
|
readonly environmentVariables: EnvironmentVariablesService;
|
|
741
868
|
readonly onboarding: OnboardingService;
|
|
742
869
|
readonly organizations: OrganizationsService;
|
|
870
|
+
readonly roles: RolesService;
|
|
743
871
|
readonly users: UsersService;
|
|
744
872
|
readonly request: BaseHttpRequest;
|
|
745
873
|
constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
|
|
@@ -766,4 +894,4 @@ type ErrorResponse = {
|
|
|
766
894
|
error: string;
|
|
767
895
|
};
|
|
768
896
|
|
|
769
|
-
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, ApiError, ApplicationsService, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type CallbackResponse, CancelError, CancelablePromise, type CheckSlugResponse, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type
|
|
897
|
+
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, ApiError, type ApiKeyResponse, type ApiKeysResponse, ApiKeysService, ApplicationsService, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type CallbackResponse, CancelError, CancelablePromise, type CheckSlugResponse, type CreateApiKeyRequest, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateRoleRequest, type CreateUserInviteRequest, type CreateUserInviteResponse, type DeleteAppResponse, type DeleteEnvRequest, type DeleteUserInviteResponse, type EnvResponse, EnvSyncAPISDK, type EnvTypeResponse, type EnvTypesResponse, EnvironmentTypesService, EnvironmentVariablesService, type EnvsResponse, type ErrorResponse, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetUserInviteByTokenResponse, type LoginUrlResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgResponse, OrganizationsService, type RegenerateApiKeyResponse, type RoleResponse, type RoleStatsResponse, type RolesResponse, RolesService, type UpdateApiKeyRequest, type UpdateAppRequest, type UpdateAppResponse, type UpdateEnvRequest, type UpdateOrgRequest, type UpdatePasswordRequest, type UpdateRoleRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse, type UpdateUserRequest, type UserResponse, type UsersResponse, UsersService, type WhoAmIResponse };
|
package/dist/index.d.ts
CHANGED
|
@@ -74,20 +74,12 @@ declare class AccessService {
|
|
|
74
74
|
readonly httpRequest: BaseHttpRequest;
|
|
75
75
|
constructor(httpRequest: BaseHttpRequest);
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* Initiate CLI Login
|
|
78
78
|
* Generate authentication URL for CLI login
|
|
79
|
-
* @returns LoginUrlResponse CLI login
|
|
79
|
+
* @returns LoginUrlResponse CLI login initiated successfully.
|
|
80
80
|
* @throws ApiError
|
|
81
81
|
*/
|
|
82
82
|
createCliLogin(): CancelablePromise<LoginUrlResponse>;
|
|
83
|
-
/**
|
|
84
|
-
* CLI Login Callback
|
|
85
|
-
* Handle CLI login callback from Auth0
|
|
86
|
-
* @param code
|
|
87
|
-
* @returns void
|
|
88
|
-
* @throws ApiError
|
|
89
|
-
*/
|
|
90
|
-
callbackCliLogin(code: string): CancelablePromise<void>;
|
|
91
83
|
/**
|
|
92
84
|
* Create Web Login URL
|
|
93
85
|
* Generate authentication URL for web login
|
|
@@ -120,6 +112,89 @@ declare class AccessService {
|
|
|
120
112
|
callbackApiLogin(code: string): CancelablePromise<CallbackResponse>;
|
|
121
113
|
}
|
|
122
114
|
|
|
115
|
+
type ApiKeyResponse = {
|
|
116
|
+
id: string;
|
|
117
|
+
user_id: string;
|
|
118
|
+
org_id: string;
|
|
119
|
+
description: string;
|
|
120
|
+
is_active: boolean;
|
|
121
|
+
key: string;
|
|
122
|
+
created_at: string;
|
|
123
|
+
updated_at: string;
|
|
124
|
+
last_used_at: string | null;
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
type ApiKeysResponse = Array<ApiKeyResponse>;
|
|
128
|
+
|
|
129
|
+
type CreateApiKeyRequest = {
|
|
130
|
+
name: string;
|
|
131
|
+
description?: string;
|
|
132
|
+
};
|
|
133
|
+
|
|
134
|
+
type RegenerateApiKeyResponse = {
|
|
135
|
+
newKey: string;
|
|
136
|
+
id: string;
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
type UpdateApiKeyRequest = {
|
|
140
|
+
description?: string;
|
|
141
|
+
is_active?: boolean;
|
|
142
|
+
last_used_at?: string;
|
|
143
|
+
};
|
|
144
|
+
|
|
145
|
+
declare class ApiKeysService {
|
|
146
|
+
readonly httpRequest: BaseHttpRequest;
|
|
147
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
148
|
+
/**
|
|
149
|
+
* Create API Key
|
|
150
|
+
* Create a new API key for the organization
|
|
151
|
+
* @param requestBody
|
|
152
|
+
* @returns ApiKeyResponse API key created successfully
|
|
153
|
+
* @throws ApiError
|
|
154
|
+
*/
|
|
155
|
+
createApiKey(requestBody?: CreateApiKeyRequest): CancelablePromise<ApiKeyResponse>;
|
|
156
|
+
/**
|
|
157
|
+
* Get All API Keys
|
|
158
|
+
* Retrieve all API keys for the organization
|
|
159
|
+
* @returns ApiKeysResponse API keys retrieved successfully
|
|
160
|
+
* @throws ApiError
|
|
161
|
+
*/
|
|
162
|
+
getAllApiKeys(): CancelablePromise<ApiKeysResponse>;
|
|
163
|
+
/**
|
|
164
|
+
* Get API Key
|
|
165
|
+
* Retrieve a specific API key
|
|
166
|
+
* @param id
|
|
167
|
+
* @returns ApiKeyResponse API key retrieved successfully
|
|
168
|
+
* @throws ApiError
|
|
169
|
+
*/
|
|
170
|
+
getApiKey(id: string): CancelablePromise<ApiKeyResponse>;
|
|
171
|
+
/**
|
|
172
|
+
* Update API Key
|
|
173
|
+
* Update an existing API key
|
|
174
|
+
* @param id
|
|
175
|
+
* @param requestBody
|
|
176
|
+
* @returns ApiKeyResponse API key updated successfully
|
|
177
|
+
* @throws ApiError
|
|
178
|
+
*/
|
|
179
|
+
updateApiKey(id: string, requestBody?: UpdateApiKeyRequest): CancelablePromise<ApiKeyResponse>;
|
|
180
|
+
/**
|
|
181
|
+
* Delete API Key
|
|
182
|
+
* Delete an existing API key
|
|
183
|
+
* @param id
|
|
184
|
+
* @returns ApiKeyResponse API key deleted successfully
|
|
185
|
+
* @throws ApiError
|
|
186
|
+
*/
|
|
187
|
+
deleteApiKey(id: string): CancelablePromise<ApiKeyResponse>;
|
|
188
|
+
/**
|
|
189
|
+
* Regenerate API Key
|
|
190
|
+
* Generate a new value for an existing API key
|
|
191
|
+
* @param id
|
|
192
|
+
* @returns RegenerateApiKeyResponse API key regenerated successfully
|
|
193
|
+
* @throws ApiError
|
|
194
|
+
*/
|
|
195
|
+
regenerateApiKey(id: string): CancelablePromise<RegenerateApiKeyResponse>;
|
|
196
|
+
}
|
|
197
|
+
|
|
123
198
|
type CreateAppRequest = {
|
|
124
199
|
name: string;
|
|
125
200
|
description: string;
|
|
@@ -275,14 +350,6 @@ declare class AuthenticationService {
|
|
|
275
350
|
whoami(): CancelablePromise<WhoAmIResponse>;
|
|
276
351
|
}
|
|
277
352
|
|
|
278
|
-
type CreateEnvTypeRequest = {
|
|
279
|
-
name: string;
|
|
280
|
-
};
|
|
281
|
-
|
|
282
|
-
type DeleteEnvTypeRequest = {
|
|
283
|
-
id: string;
|
|
284
|
-
};
|
|
285
|
-
|
|
286
353
|
type EnvTypeResponse = {
|
|
287
354
|
id: string;
|
|
288
355
|
name: string;
|
|
@@ -293,11 +360,6 @@ type EnvTypeResponse = {
|
|
|
293
360
|
|
|
294
361
|
type EnvTypesResponse = Array<EnvTypeResponse>;
|
|
295
362
|
|
|
296
|
-
type UpdateEnvTypeRequest = {
|
|
297
|
-
id: string;
|
|
298
|
-
name: string;
|
|
299
|
-
};
|
|
300
|
-
|
|
301
363
|
declare class EnvironmentTypesService {
|
|
302
364
|
readonly httpRequest: BaseHttpRequest;
|
|
303
365
|
constructor(httpRequest: BaseHttpRequest);
|
|
@@ -308,14 +370,6 @@ declare class EnvironmentTypesService {
|
|
|
308
370
|
* @throws ApiError
|
|
309
371
|
*/
|
|
310
372
|
getEnvTypes(): CancelablePromise<EnvTypesResponse>;
|
|
311
|
-
/**
|
|
312
|
-
* Create Environment Type
|
|
313
|
-
* Create a new environment type
|
|
314
|
-
* @param requestBody
|
|
315
|
-
* @returns EnvTypeResponse Environment type created successfully
|
|
316
|
-
* @throws ApiError
|
|
317
|
-
*/
|
|
318
|
-
createEnvType(requestBody?: CreateEnvTypeRequest): CancelablePromise<EnvTypeResponse>;
|
|
319
373
|
/**
|
|
320
374
|
* Get Environment Type
|
|
321
375
|
* Retrieve a specific environment type
|
|
@@ -324,23 +378,6 @@ declare class EnvironmentTypesService {
|
|
|
324
378
|
* @throws ApiError
|
|
325
379
|
*/
|
|
326
380
|
getEnvType(id: string): CancelablePromise<EnvTypeResponse>;
|
|
327
|
-
/**
|
|
328
|
-
* Update Environment Type
|
|
329
|
-
* Update an existing environment type
|
|
330
|
-
* @param id
|
|
331
|
-
* @param requestBody
|
|
332
|
-
* @returns EnvTypeResponse Environment type updated successfully
|
|
333
|
-
* @throws ApiError
|
|
334
|
-
*/
|
|
335
|
-
updateEnvType(id: string, requestBody?: UpdateEnvTypeRequest): CancelablePromise<EnvTypeResponse>;
|
|
336
|
-
/**
|
|
337
|
-
* Delete Environment Type
|
|
338
|
-
* Delete an existing environment type
|
|
339
|
-
* @param id
|
|
340
|
-
* @returns DeleteEnvTypeRequest Environment type deleted successfully
|
|
341
|
-
* @throws ApiError
|
|
342
|
-
*/
|
|
343
|
-
deleteEnvType(id: string): CancelablePromise<DeleteEnvTypeRequest>;
|
|
344
381
|
}
|
|
345
382
|
|
|
346
383
|
type BatchCreateEnvsRequest = {
|
|
@@ -646,14 +683,103 @@ declare class OrganizationsService {
|
|
|
646
683
|
checkIfSlugExists(slug: string): CancelablePromise<CheckSlugResponse>;
|
|
647
684
|
}
|
|
648
685
|
|
|
649
|
-
type
|
|
650
|
-
|
|
686
|
+
type CreateRoleRequest = {
|
|
687
|
+
name: string;
|
|
688
|
+
can_edit: boolean;
|
|
689
|
+
can_view: boolean;
|
|
690
|
+
have_api_access: boolean;
|
|
691
|
+
have_billing_options: boolean;
|
|
692
|
+
have_webhook_access: boolean;
|
|
693
|
+
is_admin: boolean;
|
|
694
|
+
};
|
|
695
|
+
|
|
696
|
+
type RoleResponse = {
|
|
697
|
+
id: string;
|
|
698
|
+
name: string;
|
|
699
|
+
org_id: string;
|
|
700
|
+
can_edit: boolean;
|
|
701
|
+
can_view: boolean;
|
|
702
|
+
have_api_access: boolean;
|
|
703
|
+
have_billing_options: boolean;
|
|
704
|
+
have_webhook_access: boolean;
|
|
705
|
+
is_admin: boolean;
|
|
706
|
+
is_master: boolean;
|
|
707
|
+
created_at: string;
|
|
708
|
+
updated_at: string;
|
|
709
|
+
};
|
|
710
|
+
|
|
711
|
+
type RolesResponse = Array<RoleResponse>;
|
|
712
|
+
|
|
713
|
+
type RoleStatsResponse = {
|
|
714
|
+
admin_access_count: number;
|
|
715
|
+
billing_access_count: number;
|
|
716
|
+
api_access_count: number;
|
|
717
|
+
webhook_access_count: number;
|
|
718
|
+
view_access_count: number;
|
|
719
|
+
edit_access_count: number;
|
|
720
|
+
total_roles: number;
|
|
651
721
|
};
|
|
652
722
|
|
|
653
723
|
type UpdateRoleRequest = {
|
|
654
724
|
role_id: string;
|
|
655
725
|
};
|
|
656
726
|
|
|
727
|
+
declare class RolesService {
|
|
728
|
+
readonly httpRequest: BaseHttpRequest;
|
|
729
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
730
|
+
/**
|
|
731
|
+
* Get All Roles
|
|
732
|
+
* Retrieve all roles in the organization
|
|
733
|
+
* @returns RolesResponse Roles retrieved successfully
|
|
734
|
+
* @throws ApiError
|
|
735
|
+
*/
|
|
736
|
+
getAllRoles(): CancelablePromise<RolesResponse>;
|
|
737
|
+
/**
|
|
738
|
+
* Create Role
|
|
739
|
+
* Create a new role in the organization
|
|
740
|
+
* @param requestBody
|
|
741
|
+
* @returns RoleResponse Role created successfully
|
|
742
|
+
* @throws ApiError
|
|
743
|
+
*/
|
|
744
|
+
createRole(requestBody?: CreateRoleRequest): CancelablePromise<RoleResponse>;
|
|
745
|
+
/**
|
|
746
|
+
* Get Role Statistics
|
|
747
|
+
* Retrieve statistics about roles in the organization
|
|
748
|
+
* @returns RoleStatsResponse Role statistics retrieved successfully
|
|
749
|
+
* @throws ApiError
|
|
750
|
+
*/
|
|
751
|
+
getRoleStats(): CancelablePromise<RoleStatsResponse>;
|
|
752
|
+
/**
|
|
753
|
+
* Get Role
|
|
754
|
+
* Retrieve a specific role by ID
|
|
755
|
+
* @param id
|
|
756
|
+
* @returns RoleResponse Role retrieved successfully
|
|
757
|
+
* @throws ApiError
|
|
758
|
+
*/
|
|
759
|
+
getRole(id: string): CancelablePromise<RoleResponse>;
|
|
760
|
+
/**
|
|
761
|
+
* Update Role
|
|
762
|
+
* Update an existing role
|
|
763
|
+
* @param id
|
|
764
|
+
* @param requestBody
|
|
765
|
+
* @returns RoleResponse Role updated successfully
|
|
766
|
+
* @throws ApiError
|
|
767
|
+
*/
|
|
768
|
+
updateRole(id: string, requestBody?: UpdateRoleRequest): CancelablePromise<RoleResponse>;
|
|
769
|
+
/**
|
|
770
|
+
* Delete Role
|
|
771
|
+
* Delete an existing role (non-master roles only)
|
|
772
|
+
* @param id
|
|
773
|
+
* @returns RoleResponse Role deleted successfully
|
|
774
|
+
* @throws ApiError
|
|
775
|
+
*/
|
|
776
|
+
deleteRole(id: string): CancelablePromise<RoleResponse>;
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
type UpdatePasswordRequest = {
|
|
780
|
+
password: string;
|
|
781
|
+
};
|
|
782
|
+
|
|
657
783
|
type UpdateUserRequest = {
|
|
658
784
|
full_name?: string;
|
|
659
785
|
profile_picture_url?: string;
|
|
@@ -733,6 +859,7 @@ declare class UsersService {
|
|
|
733
859
|
type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
|
|
734
860
|
declare class EnvSyncAPISDK {
|
|
735
861
|
readonly access: AccessService;
|
|
862
|
+
readonly apiKeys: ApiKeysService;
|
|
736
863
|
readonly applications: ApplicationsService;
|
|
737
864
|
readonly auditLogs: AuditLogsService;
|
|
738
865
|
readonly authentication: AuthenticationService;
|
|
@@ -740,6 +867,7 @@ declare class EnvSyncAPISDK {
|
|
|
740
867
|
readonly environmentVariables: EnvironmentVariablesService;
|
|
741
868
|
readonly onboarding: OnboardingService;
|
|
742
869
|
readonly organizations: OrganizationsService;
|
|
870
|
+
readonly roles: RolesService;
|
|
743
871
|
readonly users: UsersService;
|
|
744
872
|
readonly request: BaseHttpRequest;
|
|
745
873
|
constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
|
|
@@ -766,4 +894,4 @@ type ErrorResponse = {
|
|
|
766
894
|
error: string;
|
|
767
895
|
};
|
|
768
896
|
|
|
769
|
-
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, ApiError, ApplicationsService, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type CallbackResponse, CancelError, CancelablePromise, type CheckSlugResponse, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type
|
|
897
|
+
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, ApiError, type ApiKeyResponse, type ApiKeysResponse, ApiKeysService, ApplicationsService, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type CallbackResponse, CancelError, CancelablePromise, type CheckSlugResponse, type CreateApiKeyRequest, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateRoleRequest, type CreateUserInviteRequest, type CreateUserInviteResponse, type DeleteAppResponse, type DeleteEnvRequest, type DeleteUserInviteResponse, type EnvResponse, EnvSyncAPISDK, type EnvTypeResponse, type EnvTypesResponse, EnvironmentTypesService, EnvironmentVariablesService, type EnvsResponse, type ErrorResponse, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetUserInviteByTokenResponse, type LoginUrlResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgResponse, OrganizationsService, type RegenerateApiKeyResponse, type RoleResponse, type RoleStatsResponse, type RolesResponse, RolesService, type UpdateApiKeyRequest, type UpdateAppRequest, type UpdateAppResponse, type UpdateEnvRequest, type UpdateOrgRequest, type UpdatePasswordRequest, type UpdateRoleRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse, type UpdateUserRequest, type UserResponse, type UsersResponse, UsersService, type WhoAmIResponse };
|