@squidcloud/client 1.0.441 → 1.0.442
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.
|
@@ -46,10 +46,10 @@ export interface CreateManagementApiKeyRequest {
|
|
|
46
46
|
* @category ManagementApiKey
|
|
47
47
|
*/
|
|
48
48
|
export interface CreateManagementApiKeyResponse {
|
|
49
|
-
/** The created key
|
|
50
|
-
key: ManagementApiKey
|
|
51
|
-
|
|
52
|
-
|
|
49
|
+
/** The created key metadata */
|
|
50
|
+
key: ManagementApiKey;
|
|
51
|
+
/** The raw key value (only returned once during creation) */
|
|
52
|
+
keyValue: string;
|
|
53
53
|
}
|
|
54
54
|
/**
|
|
55
55
|
* Request to update a management API key's status.
|
|
@@ -7,7 +7,7 @@ export interface ManagementClientOptions {
|
|
|
7
7
|
/** The management API key (starts with 'squid_mgmt_') */
|
|
8
8
|
apiKey: string;
|
|
9
9
|
/** The Squid region to connect to */
|
|
10
|
-
|
|
10
|
+
consoleRegion: SquidRegion;
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
13
|
* Request to create a new organization.
|
|
@@ -44,14 +44,10 @@ export interface ManagementCreateApplicationRequest {
|
|
|
44
44
|
export interface ManagementCreateApplicationResponse {
|
|
45
45
|
/** The ID of the created application */
|
|
46
46
|
appId: string;
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
*/
|
|
52
|
-
export interface ManagementDeleteApplicationRequest {
|
|
53
|
-
/** The ID of the application to delete */
|
|
54
|
-
appId: string;
|
|
47
|
+
/** The API key for the dev environment */
|
|
48
|
+
devApiKey: string;
|
|
49
|
+
/** The API key for the prod environment */
|
|
50
|
+
prodApiKey: string;
|
|
55
51
|
}
|
|
56
52
|
/**
|
|
57
53
|
* Client for programmatic management of Squid organizations and applications.
|
|
@@ -77,14 +73,14 @@ export interface ManagementDeleteApplicationRequest {
|
|
|
77
73
|
* });
|
|
78
74
|
*
|
|
79
75
|
* // Delete an application
|
|
80
|
-
* await client.deleteApplication(
|
|
76
|
+
* await client.deleteApplication('my-app-id');
|
|
81
77
|
* ```
|
|
82
78
|
*
|
|
83
79
|
* @category ManagementClient
|
|
84
80
|
*/
|
|
85
81
|
export declare class ManagementClient {
|
|
86
82
|
private readonly apiKey;
|
|
87
|
-
private readonly
|
|
83
|
+
private readonly consoleRegion;
|
|
88
84
|
/**
|
|
89
85
|
* Creates a new ManagementClient.
|
|
90
86
|
*
|
|
@@ -106,7 +102,7 @@ export declare class ManagementClient {
|
|
|
106
102
|
* Requires the user to be an admin in the target organization.
|
|
107
103
|
*
|
|
108
104
|
* @param request - The application creation request
|
|
109
|
-
* @returns The created application's ID
|
|
105
|
+
* @returns The created application's ID and API keys
|
|
110
106
|
* @throws Error if user is not admin or organization quota reached
|
|
111
107
|
*/
|
|
112
108
|
createApplication(request: ManagementCreateApplicationRequest): Promise<ManagementCreateApplicationResponse>;
|
|
@@ -114,8 +110,8 @@ export declare class ManagementClient {
|
|
|
114
110
|
* Deletes an application.
|
|
115
111
|
* Requires the user to be an admin in the application's organization.
|
|
116
112
|
*
|
|
117
|
-
* @param
|
|
113
|
+
* @param appId - The ID of the application to delete
|
|
118
114
|
* @throws Error if user is not admin or application not found
|
|
119
115
|
*/
|
|
120
|
-
deleteApplication(
|
|
116
|
+
deleteApplication(appId: string): Promise<void>;
|
|
121
117
|
}
|