@stack-spot/portal-network 0.1.0 → 0.3.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/CHANGELOG.md +21 -0
- package/package.json +7 -6
- package/src/apis.json +2 -10
- package/src/client/account.ts +111 -4
- package/src/error/CanceledError.ts +3 -0
- package/src/error/DefaultAPIError.ts +27 -1
- package/src/error/StackspotAPIError.ts +33 -1
- package/src/index.ts +1 -0
- package/src/network/AutoInfiniteQuery.ts +104 -0
- package/src/network/AutoOperation.ts +7 -1
- package/src/network/AutoQuery.ts +2 -1
- package/src/network/ManualInfiniteQuery.ts +95 -0
- package/src/network/ManualQuery.ts +2 -2
- package/src/network/NetworkClient.ts +53 -41
- package/src/network/ReactQueryNetworkClient.ts +131 -33
- package/src/network/react-query-client.ts +3 -0
- package/src/network/types.ts +207 -11
- package/src/utils/use-extended-list.ts +80 -0
- package/.generate-api.failed.json +0 -1
- package/dist/api/account.d.ts +0 -2368
- package/dist/api/account.d.ts.map +0 -1
- package/dist/api/account.js +0 -1521
- package/dist/api/account.js.map +0 -1
- package/dist/api/ai.d.ts +0 -1432
- package/dist/api/ai.d.ts.map +0 -1
- package/dist/api/ai.js +0 -1342
- package/dist/api/ai.js.map +0 -1
- package/dist/api/apiRuntime.d.ts +0 -922
- package/dist/api/apiRuntime.d.ts.map +0 -1
- package/dist/api/apiRuntime.js +0 -599
- package/dist/api/apiRuntime.js.map +0 -1
- package/dist/api/cloudAccount.d.ts +0 -473
- package/dist/api/cloudAccount.d.ts.map +0 -1
- package/dist/api/cloudAccount.js +0 -300
- package/dist/api/cloudAccount.js.map +0 -1
- package/dist/api/cloudServices.d.ts +0 -1233
- package/dist/api/cloudServices.d.ts.map +0 -1
- package/dist/api/cloudServices.js +0 -715
- package/dist/api/cloudServices.js.map +0 -1
- package/dist/api/insights.d.ts +0 -123
- package/dist/api/insights.d.ts.map +0 -1
- package/dist/api/insights.js +0 -112
- package/dist/api/insights.js.map +0 -1
- package/dist/api/plugin.d.ts +0 -368
- package/dist/api/plugin.d.ts.map +0 -1
- package/dist/api/plugin.js +0 -218
- package/dist/api/plugin.js.map +0 -1
- package/dist/api/serviceCatalog.d.ts +0 -737
- package/dist/api/serviceCatalog.d.ts.map +0 -1
- package/dist/api/serviceCatalog.js +0 -611
- package/dist/api/serviceCatalog.js.map +0 -1
- package/dist/api/workflows.d.ts +0 -366
- package/dist/api/workflows.d.ts.map +0 -1
- package/dist/api/workflows.js +0 -175
- package/dist/api/workflows.js.map +0 -1
- package/dist/api/workspace.js +0 -1476
- package/dist/api/workspace.js.map +0 -1
- package/dist/api/workspaceManager.d.ts +0 -1121
- package/dist/api/workspaceManager.d.ts.map +0 -1
- package/dist/api/workspaceManager.js +0 -357
- package/dist/api/workspaceManager.js.map +0 -1
- package/dist/api/workspaceSearchEngine.d.ts +0 -93
- package/dist/api/workspaceSearchEngine.d.ts.map +0 -1
- package/dist/api/workspaceSearchEngine.js +0 -55
- package/dist/api/workspaceSearchEngine.js.map +0 -1
- package/dist/apis.json +0 -129
- package/dist/client/account.d.ts +0 -46
- package/dist/client/account.d.ts.map +0 -1
- package/dist/client/account.js +0 -104
- package/dist/client/account.js.map +0 -1
- package/dist/error/CanceledError.d.ts +0 -5
- package/dist/error/CanceledError.d.ts.map +0 -1
- package/dist/error/CanceledError.js +0 -7
- package/dist/error/CanceledError.js.map +0 -1
- package/dist/error/DefaultAPIError.d.ts +0 -9
- package/dist/error/DefaultAPIError.d.ts.map +0 -1
- package/dist/error/DefaultAPIError.js +0 -58
- package/dist/error/DefaultAPIError.js.map +0 -1
- package/dist/error/StackspotAPIError.d.ts +0 -19
- package/dist/error/StackspotAPIError.d.ts.map +0 -1
- package/dist/error/StackspotAPIError.js +0 -39
- package/dist/error/StackspotAPIError.js.map +0 -1
- package/dist/error/dictionary/account.d.ts +0 -55
- package/dist/error/dictionary/account.d.ts.map +0 -1
- package/dist/error/dictionary/account.js +0 -55
- package/dist/error/dictionary/account.js.map +0 -1
- package/dist/error/dictionary/action.d.ts +0 -163
- package/dist/error/dictionary/action.d.ts.map +0 -1
- package/dist/error/dictionary/action.js +0 -163
- package/dist/error/dictionary/action.js.map +0 -1
- package/dist/error/dictionary/base.d.ts +0 -21
- package/dist/error/dictionary/base.d.ts.map +0 -1
- package/dist/error/dictionary/base.js +0 -21
- package/dist/error/dictionary/base.js.map +0 -1
- package/dist/error/dictionary/cnt-fields.d.ts +0 -13
- package/dist/error/dictionary/cnt-fields.d.ts.map +0 -1
- package/dist/error/dictionary/cnt-fields.js +0 -13
- package/dist/error/dictionary/cnt-fields.js.map +0 -1
- package/dist/error/dictionary/cnt.d.ts +0 -79
- package/dist/error/dictionary/cnt.d.ts.map +0 -1
- package/dist/error/dictionary/cnt.js +0 -79
- package/dist/error/dictionary/cnt.js.map +0 -1
- package/dist/error/dictionary/rte.d.ts +0 -23
- package/dist/error/dictionary/rte.d.ts.map +0 -1
- package/dist/error/dictionary/rte.js +0 -23
- package/dist/error/dictionary/rte.js.map +0 -1
- package/dist/error/dictionary/rtm.d.ts +0 -9
- package/dist/error/dictionary/rtm.d.ts.map +0 -1
- package/dist/error/dictionary/rtm.js +0 -9
- package/dist/error/dictionary/rtm.js.map +0 -1
- package/dist/error/dictionary/workspace-fields.d.ts +0 -9
- package/dist/error/dictionary/workspace-fields.d.ts.map +0 -1
- package/dist/error/dictionary/workspace-fields.js +0 -9
- package/dist/error/dictionary/workspace-fields.js.map +0 -1
- package/dist/error/dictionary/workspace.d.ts +0 -99
- package/dist/error/dictionary/workspace.d.ts.map +0 -1
- package/dist/error/dictionary/workspace.js +0 -99
- package/dist/error/dictionary/workspace.js.map +0 -1
- package/dist/index.d.ts +0 -6
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -6
- package/dist/index.js.map +0 -1
- package/dist/network/AutoMutation.d.ts +0 -10
- package/dist/network/AutoMutation.d.ts.map +0 -1
- package/dist/network/AutoMutation.js +0 -20
- package/dist/network/AutoMutation.js.map +0 -1
- package/dist/network/AutoOperation.d.ts +0 -19
- package/dist/network/AutoOperation.d.ts.map +0 -1
- package/dist/network/AutoOperation.js +0 -99
- package/dist/network/AutoOperation.js.map +0 -1
- package/dist/network/AutoQuery.d.ts +0 -19
- package/dist/network/AutoQuery.d.ts.map +0 -1
- package/dist/network/AutoQuery.js +0 -70
- package/dist/network/AutoQuery.js.map +0 -1
- package/dist/network/ManualMutation.d.ts +0 -11
- package/dist/network/ManualMutation.d.ts.map +0 -1
- package/dist/network/ManualMutation.js +0 -32
- package/dist/network/ManualMutation.js.map +0 -1
- package/dist/network/ManualOperation.d.ts +0 -13
- package/dist/network/ManualOperation.d.ts.map +0 -1
- package/dist/network/ManualOperation.js +0 -53
- package/dist/network/ManualOperation.js.map +0 -1
- package/dist/network/ManualQuery.d.ts +0 -20
- package/dist/network/ManualQuery.d.ts.map +0 -1
- package/dist/network/ManualQuery.js +0 -77
- package/dist/network/ManualQuery.js.map +0 -1
- package/dist/network/NetworkClient.d.ts +0 -20
- package/dist/network/NetworkClient.d.ts.map +0 -1
- package/dist/network/NetworkClient.js +0 -85
- package/dist/network/NetworkClient.js.map +0 -1
- package/dist/network/ReactQueryNetworkClient.d.ts +0 -16
- package/dist/network/ReactQueryNetworkClient.d.ts.map +0 -1
- package/dist/network/ReactQueryNetworkClient.js +0 -125
- package/dist/network/ReactQueryNetworkClient.js.map +0 -1
- package/dist/network/react-query-client.d.ts +0 -3
- package/dist/network/react-query-client.d.ts.map +0 -1
- package/dist/network/react-query-client.js +0 -3
- package/dist/network/react-query-client.js.map +0 -1
- package/dist/network/types.d.ts +0 -55
- package/dist/network/types.d.ts.map +0 -1
- package/dist/network/types.js +0 -2
- package/dist/network/types.js.map +0 -1
- package/src/api/plugin.ts +0 -685
|
@@ -1,1233 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* OpenAPI definition
|
|
3
|
-
* v0
|
|
4
|
-
* DO NOT MODIFY - This file has been generated using oazapfts.
|
|
5
|
-
* See https://www.npmjs.com/package/oazapfts
|
|
6
|
-
*/
|
|
7
|
-
import * as Oazapfts from "@oazapfts/runtime";
|
|
8
|
-
export declare const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders>;
|
|
9
|
-
export declare const servers: {
|
|
10
|
-
generatedServerUrl: string;
|
|
11
|
-
};
|
|
12
|
-
export type JwtToken = {
|
|
13
|
-
rawToken: string;
|
|
14
|
-
email: string;
|
|
15
|
-
name: string;
|
|
16
|
-
stackSpotAccountId: string;
|
|
17
|
-
stackSpotAccountSlug: string;
|
|
18
|
-
ipSource?: string;
|
|
19
|
-
isServiceToken: boolean;
|
|
20
|
-
};
|
|
21
|
-
export type JwtTokenWrite = {
|
|
22
|
-
authenticationHeader?: string;
|
|
23
|
-
rawToken: string;
|
|
24
|
-
email: string;
|
|
25
|
-
name: string;
|
|
26
|
-
stackSpotAccountId: string;
|
|
27
|
-
stackSpotAccountSlug: string;
|
|
28
|
-
ipSource?: string;
|
|
29
|
-
isServiceToken: boolean;
|
|
30
|
-
};
|
|
31
|
-
export type Attachment = {
|
|
32
|
-
id: string;
|
|
33
|
-
filename: string;
|
|
34
|
-
resourceUrl: string;
|
|
35
|
-
contentType: string;
|
|
36
|
-
};
|
|
37
|
-
export type CaseComment = {
|
|
38
|
-
/** Name of the author of the comment. */
|
|
39
|
-
authorName: string;
|
|
40
|
-
/** Email of the author of the comment. */
|
|
41
|
-
authorEmail: string;
|
|
42
|
-
/** URL to the author's avatar. */
|
|
43
|
-
authorPhotoURL?: string;
|
|
44
|
-
/** The comment text. */
|
|
45
|
-
text: string;
|
|
46
|
-
createdAt: string;
|
|
47
|
-
attachments: Attachment[];
|
|
48
|
-
};
|
|
49
|
-
export type Case = {
|
|
50
|
-
/** Unique identifier for the case. */
|
|
51
|
-
id: string;
|
|
52
|
-
/** The case type. */
|
|
53
|
-
"type": "AccountAndBilling" | "Technical";
|
|
54
|
-
/** The case status. An user may cancel a ticket if the status is 'open'. */
|
|
55
|
-
status: string;
|
|
56
|
-
/** The StackSpot service related to the case. */
|
|
57
|
-
service: string;
|
|
58
|
-
category: string;
|
|
59
|
-
severity: string;
|
|
60
|
-
/** The case subject. */
|
|
61
|
-
subject?: string;
|
|
62
|
-
/** The list of comments in the case. */
|
|
63
|
-
comment: CaseComment[];
|
|
64
|
-
createdAt: string;
|
|
65
|
-
};
|
|
66
|
-
export type ValidationDetails = {
|
|
67
|
-
code: string;
|
|
68
|
-
field?: string;
|
|
69
|
-
details?: string;
|
|
70
|
-
values?: string[];
|
|
71
|
-
};
|
|
72
|
-
export type CreateCaseComment = {
|
|
73
|
-
/** The comment's text */
|
|
74
|
-
text: string;
|
|
75
|
-
attachmentIds: string[];
|
|
76
|
-
};
|
|
77
|
-
export type CaseUpdate = {
|
|
78
|
-
/** Case severity */
|
|
79
|
-
severity?: string;
|
|
80
|
-
comment?: CreateCaseComment;
|
|
81
|
-
/** Update the case status. The user may only update the status if the case is 'open'. */
|
|
82
|
-
status?: string;
|
|
83
|
-
};
|
|
84
|
-
export type SavingPlanComment = {
|
|
85
|
-
/** Name of the author of the comment. */
|
|
86
|
-
authorName: string;
|
|
87
|
-
/** Email of the author of the comment. */
|
|
88
|
-
authorEmail: string;
|
|
89
|
-
/** URL to the author's avatar. */
|
|
90
|
-
authorPhotoURL?: string;
|
|
91
|
-
/** The comment text. */
|
|
92
|
-
text: string;
|
|
93
|
-
createdAt: string;
|
|
94
|
-
};
|
|
95
|
-
export type SavingPlan = {
|
|
96
|
-
/** Unique identifier for the saving plan. */
|
|
97
|
-
id: number;
|
|
98
|
-
/** The saving plan status. */
|
|
99
|
-
status: string;
|
|
100
|
-
/** The saving plan type. */
|
|
101
|
-
savingPlanType: "SavingPlan" | "ReservedInstances";
|
|
102
|
-
/** The list of comments in the saving plan. */
|
|
103
|
-
comment: SavingPlanComment[];
|
|
104
|
-
};
|
|
105
|
-
export type CreateSavingPlanComment = {
|
|
106
|
-
/** The comment's text */
|
|
107
|
-
text: string;
|
|
108
|
-
};
|
|
109
|
-
export type SavingPlanUpdate = {
|
|
110
|
-
comment?: CreateSavingPlanComment;
|
|
111
|
-
/** Update saving plan status. */
|
|
112
|
-
status?: string;
|
|
113
|
-
};
|
|
114
|
-
export type GuardrailUpdate = {
|
|
115
|
-
/** The ID of GuardRail that will be updated */
|
|
116
|
-
id: string;
|
|
117
|
-
/** The GuardRail title */
|
|
118
|
-
title?: string;
|
|
119
|
-
/** A description explaining what GuardRail do */
|
|
120
|
-
description?: string;
|
|
121
|
-
/** Indicates if GuardRail is active to users use it */
|
|
122
|
-
active?: boolean;
|
|
123
|
-
/** Indicates if GuardRail is configurable for user */
|
|
124
|
-
configurable?: boolean;
|
|
125
|
-
/** Type of implementation */
|
|
126
|
-
implementation?: "RECOMENDATION" | "MANDATORY";
|
|
127
|
-
/** Type of action taken by GuardRail */
|
|
128
|
-
action?: "REMEDIATION" | "NOTIFICATION" | "NOT_IMPLEMENTED";
|
|
129
|
-
/** The type of GuardRail. [SCP, GUARDRAIL] */
|
|
130
|
-
"type"?: "SCP" | "GUARDRAIL";
|
|
131
|
-
};
|
|
132
|
-
export type GuardrailRequest = {
|
|
133
|
-
/** The baseline id that GuardRail belongs */
|
|
134
|
-
baselineId: string;
|
|
135
|
-
/** The GuardRail title */
|
|
136
|
-
title: string;
|
|
137
|
-
/** A description explaining what GuardRail do */
|
|
138
|
-
description: string;
|
|
139
|
-
/** Indicates if GuardRail is active to users use it */
|
|
140
|
-
active: boolean;
|
|
141
|
-
/** Indicates if GuardRail is configurable for user */
|
|
142
|
-
configurable: boolean;
|
|
143
|
-
/** Type of implementation */
|
|
144
|
-
implementation: "RECOMENDATION" | "MANDATORY";
|
|
145
|
-
/** Type of action taken by GuardRail */
|
|
146
|
-
action: "REMEDIATION" | "NOTIFICATION" | "NOT_IMPLEMENTED";
|
|
147
|
-
/** The type of GuardRail. [SCP, GUARDRAIL] */
|
|
148
|
-
"type": "SCP" | "GUARDRAIL";
|
|
149
|
-
};
|
|
150
|
-
export type GuardrailDetails = {
|
|
151
|
-
/** The guardrail ID */
|
|
152
|
-
id: string;
|
|
153
|
-
};
|
|
154
|
-
export type BaselineUpdate = {
|
|
155
|
-
/** The baseline title */
|
|
156
|
-
title: string;
|
|
157
|
-
/** The date when that Baseline was published */
|
|
158
|
-
publishedAt?: string;
|
|
159
|
-
/** Status of the baseline, if it's published or a draft */
|
|
160
|
-
status?: string;
|
|
161
|
-
};
|
|
162
|
-
export type BillingAccountSummaryResponse = {
|
|
163
|
-
/** ULID identifier for each billing account. */
|
|
164
|
-
id: string;
|
|
165
|
-
/** Slug identifier for each billing account. */
|
|
166
|
-
name: string;
|
|
167
|
-
/** StackSpot's ULID identifier for each client. */
|
|
168
|
-
stackSpotAccountId: string;
|
|
169
|
-
};
|
|
170
|
-
export type BillingAccountRequest = {
|
|
171
|
-
/** Slug identifier for each billing account. */
|
|
172
|
-
name: string;
|
|
173
|
-
/** StackSpot's ULID identifier for each client. */
|
|
174
|
-
stackSpotAccountId: string;
|
|
175
|
-
/** The AWS S3 bucket name used for CUR (Cost and Usage Report). */
|
|
176
|
-
awsCurBucketName: string;
|
|
177
|
-
/** The AWS region where the CUR bucket is located. */
|
|
178
|
-
awsCurBucketRegion: string;
|
|
179
|
-
/** The name of the AWS CUR report. */
|
|
180
|
-
awsCurReportName: string;
|
|
181
|
-
/** The prefix used in the AWS CUR bucket for reports. */
|
|
182
|
-
awsCurPrefix: string;
|
|
183
|
-
/** The AWS IAM Role ARN with permissions to access CUR data. */
|
|
184
|
-
awsRoleArn: string;
|
|
185
|
-
/** The AWS Secret Manager secret ARN containing the External ID. */
|
|
186
|
-
awsSecretIdArn: string;
|
|
187
|
-
};
|
|
188
|
-
export type BillingAccountDetailsResponse = {
|
|
189
|
-
/** ULID identifier for each billing account. */
|
|
190
|
-
id: string;
|
|
191
|
-
/** Slug identifier for each billing account. */
|
|
192
|
-
name: string;
|
|
193
|
-
/** StackSpot's ULID identifier for each client. */
|
|
194
|
-
stackSpotAccountId: string;
|
|
195
|
-
/** The AWS S3 bucket name used for CUR (Cost and Usage Report). */
|
|
196
|
-
awsCurBucketName: string;
|
|
197
|
-
/** The AWS region where the CUR bucket is located. */
|
|
198
|
-
awsCurBucketRegion: string;
|
|
199
|
-
/** The name of the AWS CUR report. */
|
|
200
|
-
awsCurReportName: string;
|
|
201
|
-
/** The prefix used in the AWS CUR bucket for reports. */
|
|
202
|
-
awsCurPrefix: string;
|
|
203
|
-
/** The AWS IAM Role ARN with permissions to access CUR data. */
|
|
204
|
-
awsRoleArn: string;
|
|
205
|
-
/** The AWS Secret Manager secret ARN containing the External ID. */
|
|
206
|
-
awsSecretIdArn?: string;
|
|
207
|
-
/** Timestamp of when the billing account was marked as deleted. */
|
|
208
|
-
deletedAt?: string;
|
|
209
|
-
/** Timestamp of when the billing account was created. */
|
|
210
|
-
createdAt: string;
|
|
211
|
-
/** Timestamp of the last update to the billing account. */
|
|
212
|
-
updatedAt: string;
|
|
213
|
-
};
|
|
214
|
-
export type Ulid = {
|
|
215
|
-
value: string;
|
|
216
|
-
};
|
|
217
|
-
export type Filter = {
|
|
218
|
-
/** A categorical attribute for context or categorization in billing data. */
|
|
219
|
-
"type": "REGION" | "SERVICE_NAME" | "SUB_ACCOUNT_ID" | "TAG_KEY" | "TAG_VALUE";
|
|
220
|
-
/** Defines the exact value the filter will look for within the specified type. */
|
|
221
|
-
value: string;
|
|
222
|
-
};
|
|
223
|
-
export type ChargePeriod = {
|
|
224
|
-
/** Represents the end date of the charge period. */
|
|
225
|
-
end: string;
|
|
226
|
-
/** Represents the end date of the charge period. */
|
|
227
|
-
start: string;
|
|
228
|
-
};
|
|
229
|
-
export type AllocationCostRequest = {
|
|
230
|
-
stackSpotAccountId: Ulid;
|
|
231
|
-
/** StackSpot-assigned ULID identifiers for a billing account. */
|
|
232
|
-
billingAccountId: Ulid[];
|
|
233
|
-
/** StackSpot-assigned ULID identifiers for a billing account. */
|
|
234
|
-
filter: Filter[];
|
|
235
|
-
/** Defines the row's time-based granularity. */
|
|
236
|
-
granularity: "PERIOD" | "MONTH";
|
|
237
|
-
/** A categorical attribute that provides context or categorization to billing data. */
|
|
238
|
-
dimension: "SERVICE_NAME" | "TAG" | "USAGE_UNIT";
|
|
239
|
-
chargePeriod: ChargePeriod;
|
|
240
|
-
};
|
|
241
|
-
export type ServiceNameResponse = GetCostAndUsageData & {
|
|
242
|
-
chargePeriod?: ChargePeriod;
|
|
243
|
-
/** Represents an offering that can be purchased from a cloud provider. */
|
|
244
|
-
serviceName?: string;
|
|
245
|
-
/** Effective cost post discounts and amortizations. */
|
|
246
|
-
effectiveCost?: number;
|
|
247
|
-
};
|
|
248
|
-
export type TagResponse = GetCostAndUsageData & {
|
|
249
|
-
chargePeriod?: ChargePeriod;
|
|
250
|
-
/** Tag key: Identifies a grouping attribute or category for resources or constructs. */
|
|
251
|
-
tagKey?: string;
|
|
252
|
-
/** Tag value: Specifies the group or category detail that the resource or construct belongs to. */
|
|
253
|
-
tagValue?: string;
|
|
254
|
-
/** Effective cost post discounts and amortizations. */
|
|
255
|
-
effectiveCost?: number;
|
|
256
|
-
};
|
|
257
|
-
export type UsageUnitResponse = GetCostAndUsageData & {
|
|
258
|
-
chargePeriod?: ChargePeriod;
|
|
259
|
-
/** Represents an offering that can be purchased from a cloud provider. */
|
|
260
|
-
serviceName?: string;
|
|
261
|
-
/** Represents the volume of a given resource or service used or purchased based on the Usage Unit. */
|
|
262
|
-
usageQuantity?: number;
|
|
263
|
-
/** Defines the unit of measurement for the resource or service. */
|
|
264
|
-
usageUnit?: string;
|
|
265
|
-
/** Effective cost post discounts and amortizations. */
|
|
266
|
-
effectiveCost?: number;
|
|
267
|
-
};
|
|
268
|
-
export type GetCostAndUsageData = ({
|
|
269
|
-
"type": "ServiceNameResponse";
|
|
270
|
-
} & ServiceNameResponse) | ({
|
|
271
|
-
"type": "TagResponse";
|
|
272
|
-
} & TagResponse) | ({
|
|
273
|
-
"type": "UsageUnitResponse";
|
|
274
|
-
} & UsageUnitResponse);
|
|
275
|
-
export type AllocationCostResponse = {
|
|
276
|
-
/** Unique identifier for the task, used for tracking and retrieval. */
|
|
277
|
-
id: string;
|
|
278
|
-
/** Current status of the task, indicating its lifecycle phase. */
|
|
279
|
-
status: "PROCESSING" | "SUCCESS" | "ERROR";
|
|
280
|
-
/** Contains processed data, available when status is SUCCESS. */
|
|
281
|
-
data: GetCostAndUsageData[];
|
|
282
|
-
/** Optional details on processing status, providing task insights or error explanations. */
|
|
283
|
-
message: string;
|
|
284
|
-
};
|
|
285
|
-
export type ProblemDetail = {
|
|
286
|
-
"type"?: string;
|
|
287
|
-
title?: string;
|
|
288
|
-
status?: number;
|
|
289
|
-
detail?: string;
|
|
290
|
-
instance?: string;
|
|
291
|
-
properties?: {
|
|
292
|
-
[key: string]: object;
|
|
293
|
-
};
|
|
294
|
-
};
|
|
295
|
-
export type CaseSummary = {
|
|
296
|
-
/** Unique case identifier. */
|
|
297
|
-
id: number;
|
|
298
|
-
/** The case status. */
|
|
299
|
-
status: string;
|
|
300
|
-
/** The case severity. */
|
|
301
|
-
severity: string;
|
|
302
|
-
/** The case subject. */
|
|
303
|
-
subject: string;
|
|
304
|
-
createdAt: string;
|
|
305
|
-
/** The requester email. */
|
|
306
|
-
requesterEmail: string;
|
|
307
|
-
};
|
|
308
|
-
export type ListCasesResponse = {
|
|
309
|
-
data: CaseSummary[];
|
|
310
|
-
nextPage?: string;
|
|
311
|
-
prevPage?: string;
|
|
312
|
-
count: number;
|
|
313
|
-
visibility: "AccountLevel" | "UserLevel";
|
|
314
|
-
};
|
|
315
|
-
export type CaseRequest = {
|
|
316
|
-
/** The case type */
|
|
317
|
-
"type": "AccountAndBilling" | "Technical";
|
|
318
|
-
/** StackSpot managed service name that is related to the case */
|
|
319
|
-
service: string;
|
|
320
|
-
/** Case category */
|
|
321
|
-
category: string;
|
|
322
|
-
/** Case severity */
|
|
323
|
-
severity: string;
|
|
324
|
-
comment: CreateCaseComment;
|
|
325
|
-
};
|
|
326
|
-
export type AttachmentUpload = {
|
|
327
|
-
upload: Blob;
|
|
328
|
-
filename: string;
|
|
329
|
-
contentType: string;
|
|
330
|
-
};
|
|
331
|
-
export type SavingPlanSummary = {
|
|
332
|
-
/** Unique identifier for the saving plan. */
|
|
333
|
-
id: number;
|
|
334
|
-
/** The saving plan status. */
|
|
335
|
-
status: string;
|
|
336
|
-
/** The saving plan type. */
|
|
337
|
-
savingPlanType: "SavingPlan" | "ReservedInstances";
|
|
338
|
-
};
|
|
339
|
-
export type PaginatedResourceSavingPlanSummary = {
|
|
340
|
-
data: SavingPlanSummary[];
|
|
341
|
-
nextPage?: number;
|
|
342
|
-
prevPage?: number;
|
|
343
|
-
count: number;
|
|
344
|
-
};
|
|
345
|
-
export type SavingPlanRequest = {
|
|
346
|
-
/** The saving plan type. */
|
|
347
|
-
savingPlanType: "SavingPlan" | "ReservedInstances";
|
|
348
|
-
};
|
|
349
|
-
export type RegisterOfferRequest = {
|
|
350
|
-
stackspotAccountId: string;
|
|
351
|
-
cloudOffer: "Reseller" | "Managed" | "FullyManaged";
|
|
352
|
-
};
|
|
353
|
-
export type CloudAccountResponse = {
|
|
354
|
-
/** Cloud Account ID */
|
|
355
|
-
id: string;
|
|
356
|
-
/** Workspace name */
|
|
357
|
-
workspaceName: string;
|
|
358
|
-
/** Environment name */
|
|
359
|
-
environmentName: string;
|
|
360
|
-
/** Cloud Provider */
|
|
361
|
-
provider: "AWS" | "Azure";
|
|
362
|
-
/** Cloud Account connection status */
|
|
363
|
-
status: "Connecting" | "Connected" | "Disconnected" | "Failed" | "Unknown";
|
|
364
|
-
/** Cloud Account type */
|
|
365
|
-
"type": "CustomCloud" | "CloudServices";
|
|
366
|
-
/** Number Of Ips */
|
|
367
|
-
numberOfIps?: number;
|
|
368
|
-
/** Network Type */
|
|
369
|
-
networkType?: number;
|
|
370
|
-
};
|
|
371
|
-
export type PaginatedResourceCloudAccountResponse = {
|
|
372
|
-
data: CloudAccountResponse[];
|
|
373
|
-
nextPage?: number;
|
|
374
|
-
prevPage?: number;
|
|
375
|
-
totalPages: number;
|
|
376
|
-
};
|
|
377
|
-
export type CloudAccountCredential = object;
|
|
378
|
-
export type ConnectAccountRequest = {
|
|
379
|
-
/** Environment ID */
|
|
380
|
-
environmentId: string;
|
|
381
|
-
/** Workspace ID */
|
|
382
|
-
workspaceId: string;
|
|
383
|
-
/** Cloud Provider */
|
|
384
|
-
provider: "AWS" | "Azure";
|
|
385
|
-
credential?: CloudAccountCredential;
|
|
386
|
-
/** IAM Role. Will be deprecated in future releases. */
|
|
387
|
-
iamRole?: string;
|
|
388
|
-
};
|
|
389
|
-
export type CloudAccountDetails = {
|
|
390
|
-
/** Cloud Account ID */
|
|
391
|
-
id?: string;
|
|
392
|
-
/** Workspace ID */
|
|
393
|
-
workspaceId: string;
|
|
394
|
-
/** Workspace name */
|
|
395
|
-
workspaceName: string;
|
|
396
|
-
/** Environment ID */
|
|
397
|
-
environmentId: string;
|
|
398
|
-
/** Environment name */
|
|
399
|
-
environmentName: string;
|
|
400
|
-
/** Environment description */
|
|
401
|
-
environmentDescription: string;
|
|
402
|
-
/** Cloud Provider */
|
|
403
|
-
provider?: "AWS" | "Azure";
|
|
404
|
-
/** Cloud Provider Account ID */
|
|
405
|
-
providerAccountId?: string;
|
|
406
|
-
/** Cloud Account connection status */
|
|
407
|
-
status?: "Connecting" | "Connected" | "Disconnected" | "Failed" | "Unknown";
|
|
408
|
-
/** Cloud Account type */
|
|
409
|
-
"type"?: "CustomCloud" | "CloudServices";
|
|
410
|
-
/** When not-null, it's the ID for a support case requesting the disconnection of this account */
|
|
411
|
-
activeDisconnectSupportCaseId?: string;
|
|
412
|
-
};
|
|
413
|
-
export type ManagedAccountProvisionRequest = {
|
|
414
|
-
workspaceId: Ulid;
|
|
415
|
-
/**
|
|
416
|
-
Network template ID to be setup in the provisioned accounts. See /cloud-account/managed-account/template for more info.
|
|
417
|
-
*/
|
|
418
|
-
networkTypeId: number;
|
|
419
|
-
/**
|
|
420
|
-
Number of IPs to be allocated in the provisioned accounts. See /cloud-account/managed-account/template for more info.
|
|
421
|
-
*/
|
|
422
|
-
numberOfIps: number;
|
|
423
|
-
};
|
|
424
|
-
export type DisconnectSupportCaseManagedAccountRequest = {
|
|
425
|
-
supportCaseId: number;
|
|
426
|
-
};
|
|
427
|
-
export type DisconnectSupportCaseManagedAccountResponse = {
|
|
428
|
-
cloudAccountId: Ulid;
|
|
429
|
-
stackspotAccountId: Ulid;
|
|
430
|
-
supportCaseId: number;
|
|
431
|
-
};
|
|
432
|
-
export type StackspotAccountTower = {
|
|
433
|
-
id: string;
|
|
434
|
-
stackspotAccountId: string;
|
|
435
|
-
towerId: string;
|
|
436
|
-
};
|
|
437
|
-
export type StackspotAccountTowerRequest = {
|
|
438
|
-
stackspotAccountId: string;
|
|
439
|
-
towerId: string;
|
|
440
|
-
};
|
|
441
|
-
export type CommonCreatedResponse = {
|
|
442
|
-
/** The created object ID */
|
|
443
|
-
id: string;
|
|
444
|
-
};
|
|
445
|
-
export type CreateContractRequest = {
|
|
446
|
-
stackSpotAccountId: Ulid;
|
|
447
|
-
factor: number;
|
|
448
|
-
startDate: string;
|
|
449
|
-
};
|
|
450
|
-
export type Contract = {
|
|
451
|
-
id: string;
|
|
452
|
-
stackSpotAccountId: string;
|
|
453
|
-
factor: number;
|
|
454
|
-
startDate: string;
|
|
455
|
-
};
|
|
456
|
-
export type LinkResourceTypeToStackspotAccountRequest = {
|
|
457
|
-
stackspotAccountId: Ulid;
|
|
458
|
-
serviceIds: Ulid[];
|
|
459
|
-
};
|
|
460
|
-
export type UpdateManagedInfoRequest = {
|
|
461
|
-
cloudAccountId: Ulid;
|
|
462
|
-
stackspotAccountId: Ulid;
|
|
463
|
-
/**
|
|
464
|
-
Sets the AWS region for the account.
|
|
465
|
-
*/
|
|
466
|
-
region?: string;
|
|
467
|
-
/**
|
|
468
|
-
Sets the foundation name for the account.
|
|
469
|
-
*/
|
|
470
|
-
foundationName?: string;
|
|
471
|
-
/**
|
|
472
|
-
Sets the environment name for the account.
|
|
473
|
-
*/
|
|
474
|
-
environmentName?: string;
|
|
475
|
-
};
|
|
476
|
-
export type UpdatedCloudAccountResponse = {
|
|
477
|
-
cloudAccountId: Ulid;
|
|
478
|
-
stackspotAccountId: Ulid;
|
|
479
|
-
workspaceId: Ulid;
|
|
480
|
-
environmentId: Ulid;
|
|
481
|
-
cloudType: "CustomCloud" | "CloudServices";
|
|
482
|
-
cloudStatus: "Connecting" | "Connected" | "Disconnected" | "Failed" | "Unknown";
|
|
483
|
-
/**
|
|
484
|
-
The region associated with the Cloud Account. This fields only exists for AWS accounts of CloudServices type.
|
|
485
|
-
*/
|
|
486
|
-
providerRegion?: string;
|
|
487
|
-
/**
|
|
488
|
-
The account's name inside the Foundation's organization. This fields only exists for AWS accounts of CloudServices type.
|
|
489
|
-
*/
|
|
490
|
-
foundationName: string;
|
|
491
|
-
};
|
|
492
|
-
export type DisconnectCloudAccountRequest = {
|
|
493
|
-
cloudAccountId: Ulid;
|
|
494
|
-
stackspotAccountId: Ulid;
|
|
495
|
-
};
|
|
496
|
-
export type BaselineResponse = {
|
|
497
|
-
/** The ID of baseline that will be updated */
|
|
498
|
-
id: string;
|
|
499
|
-
/** The baseline title */
|
|
500
|
-
title: string;
|
|
501
|
-
/** The date when that Baseline was published */
|
|
502
|
-
publishedAt?: string;
|
|
503
|
-
/** Status of the baseline, if it's published or a draft */
|
|
504
|
-
status?: string;
|
|
505
|
-
};
|
|
506
|
-
export type BaselineRequest = {
|
|
507
|
-
/** The baseline title */
|
|
508
|
-
title: string;
|
|
509
|
-
/** The date when that Baseline was published */
|
|
510
|
-
publishedAt?: string;
|
|
511
|
-
/** Status of the baseline, if it's published or a draft */
|
|
512
|
-
status?: string;
|
|
513
|
-
};
|
|
514
|
-
export type BaselineDetails = {
|
|
515
|
-
/** The baseline ID */
|
|
516
|
-
id: string;
|
|
517
|
-
};
|
|
518
|
-
export type SupportFormFieldOption = {
|
|
519
|
-
name: string;
|
|
520
|
-
value: string;
|
|
521
|
-
};
|
|
522
|
-
export type SupportFormFieldData = {
|
|
523
|
-
service: SupportFormFieldOption[];
|
|
524
|
-
category: SupportFormFieldOption[];
|
|
525
|
-
};
|
|
526
|
-
export type SupportFormFieldResponse = {
|
|
527
|
-
accountAndBilling: SupportFormFieldData;
|
|
528
|
-
technical: SupportFormFieldData;
|
|
529
|
-
severity: SupportFormFieldOption[];
|
|
530
|
-
};
|
|
531
|
-
export type AttachmentBase64 = {
|
|
532
|
-
filename: string;
|
|
533
|
-
base64: string;
|
|
534
|
-
contentType: string;
|
|
535
|
-
};
|
|
536
|
-
export type HealthComponent = {
|
|
537
|
-
description?: string;
|
|
538
|
-
status?: string;
|
|
539
|
-
};
|
|
540
|
-
export type GuardrailStatusResponse = {
|
|
541
|
-
/** The baseline id that GuardRail belongs */
|
|
542
|
-
baselineId: string;
|
|
543
|
-
/** The guardrail id */
|
|
544
|
-
guardrailId: string;
|
|
545
|
-
/** The GuardRail title */
|
|
546
|
-
title: string;
|
|
547
|
-
/** A description explaining what GuardRail do */
|
|
548
|
-
description: string;
|
|
549
|
-
/** Indicates if GuardRail is configurable for user */
|
|
550
|
-
configurable: boolean;
|
|
551
|
-
/** Implementation type of Guardrail */
|
|
552
|
-
implementation: "RECOMENDATION" | "MANDATORY";
|
|
553
|
-
/** Action taken by the Guardrail */
|
|
554
|
-
action: "REMEDIATION" | "NOTIFICATION" | "NOT_IMPLEMENTED";
|
|
555
|
-
/** Indicates if GuardRail is enabled */
|
|
556
|
-
enabled: boolean;
|
|
557
|
-
};
|
|
558
|
-
export type GroupedGuardrailResponse = {
|
|
559
|
-
/** The baseline id that GuardRail belongs */
|
|
560
|
-
baselineId: string;
|
|
561
|
-
/** The baseline title that GuardRail belongs */
|
|
562
|
-
baselineTitle: string;
|
|
563
|
-
/** All GuardRails attached to a Baseline */
|
|
564
|
-
guardrails: GuardrailStatusResponse[];
|
|
565
|
-
};
|
|
566
|
-
export type DailyCostSummary = {
|
|
567
|
-
date: string;
|
|
568
|
-
cost: number;
|
|
569
|
-
};
|
|
570
|
-
export type CostByWorkspace = {
|
|
571
|
-
/** Title of the workspace. */
|
|
572
|
-
workspaceName: string;
|
|
573
|
-
/** Cost associated with the workspace. */
|
|
574
|
-
cost: number;
|
|
575
|
-
};
|
|
576
|
-
export type CostOverview = {
|
|
577
|
-
/** Costs from the current month. */
|
|
578
|
-
currentMonth: number;
|
|
579
|
-
/** Costs from the last month. */
|
|
580
|
-
lastMonth: number;
|
|
581
|
-
/** Costs from the past three months. */
|
|
582
|
-
lastThreeMonths: number;
|
|
583
|
-
currentMonthAverage: number;
|
|
584
|
-
currentMonthDaily: DailyCostSummary[];
|
|
585
|
-
costByWorkspace: CostByWorkspace[];
|
|
586
|
-
};
|
|
587
|
-
export type AllocationCost = {
|
|
588
|
-
name: string;
|
|
589
|
-
costValue: number;
|
|
590
|
-
};
|
|
591
|
-
export type PaginatedResponseAllocationCost = {
|
|
592
|
-
data: AllocationCost[];
|
|
593
|
-
nextPage?: string;
|
|
594
|
-
prevPage?: string;
|
|
595
|
-
count: number;
|
|
596
|
-
};
|
|
597
|
-
export type AllocationCostDetails = {
|
|
598
|
-
serviceName: string;
|
|
599
|
-
stackSpotUsageType: string;
|
|
600
|
-
quantity: number;
|
|
601
|
-
costValue: number;
|
|
602
|
-
};
|
|
603
|
-
export type PaginatedResponseAllocationCostDetails = {
|
|
604
|
-
data: AllocationCostDetails[];
|
|
605
|
-
nextPage?: string;
|
|
606
|
-
prevPage?: string;
|
|
607
|
-
count: number;
|
|
608
|
-
};
|
|
609
|
-
export type ManagedResource = {
|
|
610
|
-
/** Unique identifier. */
|
|
611
|
-
id: string;
|
|
612
|
-
/** The resource name. */
|
|
613
|
-
name: string;
|
|
614
|
-
cloudAccountId: string;
|
|
615
|
-
cloudProviderRegion: string;
|
|
616
|
-
/** The environment type. */
|
|
617
|
-
environmentName: string;
|
|
618
|
-
/** Created at. */
|
|
619
|
-
createdAt?: string;
|
|
620
|
-
/** The resource status. */
|
|
621
|
-
status?: "Up" | "Down" | "Starting" | "Unknown";
|
|
622
|
-
};
|
|
623
|
-
export type ManagedResourceList = {
|
|
624
|
-
data: ManagedResource[];
|
|
625
|
-
pageToken?: string;
|
|
626
|
-
};
|
|
627
|
-
export type ServiceResource = {
|
|
628
|
-
id: Ulid;
|
|
629
|
-
/** The service resource name */
|
|
630
|
-
name: string;
|
|
631
|
-
};
|
|
632
|
-
export type ManagedService = {
|
|
633
|
-
/** Unique identifier. */
|
|
634
|
-
id: string;
|
|
635
|
-
/** The service name. */
|
|
636
|
-
name: string;
|
|
637
|
-
/** List of resources. */
|
|
638
|
-
resources: ServiceResource[];
|
|
639
|
-
};
|
|
640
|
-
export type CloudOfferResponse = {
|
|
641
|
-
stackspotAccountId: string;
|
|
642
|
-
offer: "Reseller" | "Managed" | "FullyManaged";
|
|
643
|
-
};
|
|
644
|
-
export type CloudServicesAccountStatus = {
|
|
645
|
-
/** Cloud Account ID */
|
|
646
|
-
id: string;
|
|
647
|
-
/** Environment name */
|
|
648
|
-
environmentName: string;
|
|
649
|
-
/** Environment ID */
|
|
650
|
-
environmentId: string;
|
|
651
|
-
/** Status of the account in the workflow */
|
|
652
|
-
status: "Connecting" | "Connected" | "Disconnected" | "Failed" | "Unknown";
|
|
653
|
-
provider: "AWS" | "Azure";
|
|
654
|
-
/** Error code if the workflow for creating the account failed */
|
|
655
|
-
errorCode?: string;
|
|
656
|
-
};
|
|
657
|
-
export type Workflow = {
|
|
658
|
-
status: "UNDER_CHANGE" | "AVAILABLE" | "ERROR";
|
|
659
|
-
accounts: CloudServicesAccountStatus[];
|
|
660
|
-
supportCaseId?: string;
|
|
661
|
-
};
|
|
662
|
-
export type CloudAccountWithCredentialResponse = {
|
|
663
|
-
/** Cloud Account ID */
|
|
664
|
-
id: string;
|
|
665
|
-
/** Workspace ID */
|
|
666
|
-
workspaceId: string;
|
|
667
|
-
/** Environment ID */
|
|
668
|
-
environmentId: string;
|
|
669
|
-
/** Cloud Provider */
|
|
670
|
-
provider: "AWS" | "Azure";
|
|
671
|
-
/** Cloud Account type */
|
|
672
|
-
"type": "CustomCloud" | "CloudServices";
|
|
673
|
-
/** Role */
|
|
674
|
-
role: string;
|
|
675
|
-
/** Cloud Account connection status */
|
|
676
|
-
status: "Connecting" | "Connected" | "Disconnected" | "Failed" | "Unknown";
|
|
677
|
-
/** Cloud Account credential identifier for Secret Manager */
|
|
678
|
-
credentialSecretIdentifier?: string;
|
|
679
|
-
};
|
|
680
|
-
export type ManagedAccountTemplateResponse = {
|
|
681
|
-
id: number;
|
|
682
|
-
name: string;
|
|
683
|
-
minCountIps: number;
|
|
684
|
-
maxCountIps: number;
|
|
685
|
-
availableIpRange?: number[];
|
|
686
|
-
};
|
|
687
|
-
export type ManagedAccountRegionResponse = {
|
|
688
|
-
id: number;
|
|
689
|
-
name: string;
|
|
690
|
-
};
|
|
691
|
-
export type Alert = {
|
|
692
|
-
/** Auto id of the alert. */
|
|
693
|
-
id: string;
|
|
694
|
-
/** Describe the pillar of the alert. It can be security, reliability or cost optimization. */
|
|
695
|
-
pillar: "SECURITY" | "COST_OPTIMIZATION" | "RELIABILITY";
|
|
696
|
-
/** Describe the environment of the alert. It can be production, staging or development. */
|
|
697
|
-
environment: string;
|
|
698
|
-
/** Workspace of the alert. */
|
|
699
|
-
workspace: string;
|
|
700
|
-
/** Describe the severity of the alert. It can be mandatory, high, medium or low. */
|
|
701
|
-
severity: "LOW" | "MEDIUM" | "HIGH" | "MANDATORY";
|
|
702
|
-
/** Describe the title of the alert. */
|
|
703
|
-
title: string;
|
|
704
|
-
/** Description of the alert. */
|
|
705
|
-
description: string;
|
|
706
|
-
/** Short description about what can be done in order to resolve the issue. */
|
|
707
|
-
remediationText: string;
|
|
708
|
-
/** Url that contains a detailed documentation to resolve the issue. */
|
|
709
|
-
remediationUrl: string;
|
|
710
|
-
/** Policy of the issue that created the alert. */
|
|
711
|
-
awsPolicy: string;
|
|
712
|
-
/** Id of the alert in AWS. */
|
|
713
|
-
sourceAlertId: string;
|
|
714
|
-
/** Id of the resource. */
|
|
715
|
-
resourceId?: string;
|
|
716
|
-
/** Status of the alert. It can be pending, completed or not applicable. */
|
|
717
|
-
status: "PENDING" | "NOT_APPLICABLE" | "COMPLETED";
|
|
718
|
-
};
|
|
719
|
-
export type PaginatedResponseAlert = {
|
|
720
|
-
data: Alert[];
|
|
721
|
-
nextPage?: string;
|
|
722
|
-
prevPage?: string;
|
|
723
|
-
count: number;
|
|
724
|
-
};
|
|
725
|
-
export type ServiceSummary = {
|
|
726
|
-
id: string;
|
|
727
|
-
name: string;
|
|
728
|
-
};
|
|
729
|
-
export type AdminCloudAccountDetails = {
|
|
730
|
-
/** Cloud Account ID */
|
|
731
|
-
id: string;
|
|
732
|
-
/** Stackspot Account ID */
|
|
733
|
-
stackspotAccountId: string;
|
|
734
|
-
/** Workspace ID */
|
|
735
|
-
workspaceId: string;
|
|
736
|
-
/** Environment ID */
|
|
737
|
-
environmentId: string;
|
|
738
|
-
/** Environment Name (only available in CloudServices accounts ) */
|
|
739
|
-
environmentName?: string;
|
|
740
|
-
/** Cloud Provider that Cloud Account represents */
|
|
741
|
-
provider: "AWS" | "Azure";
|
|
742
|
-
/** Type of the Cloud Account (Custom Cloud or Cloud Services) */
|
|
743
|
-
"type": "CustomCloud" | "CloudServices";
|
|
744
|
-
region?: string;
|
|
745
|
-
/** AWS Role that can be used for connecting in account */
|
|
746
|
-
role?: string;
|
|
747
|
-
/** Status of this Cloud Account. Connected indicates it's ready to use, others status are self explained */
|
|
748
|
-
status: "Connecting" | "Connected" | "Disconnected" | "Failed" | "Unknown";
|
|
749
|
-
/** The ID this account have in Cloud Provider */
|
|
750
|
-
cloudProviderAccountId?: string;
|
|
751
|
-
/** The name given in Cloud Provider for this account (only available in CloudServices accounts) */
|
|
752
|
-
cloudProviderAccountName?: string;
|
|
753
|
-
/** Linked Account ID */
|
|
754
|
-
linkedAccountId?: string;
|
|
755
|
-
/** This Cloud Account credentials secret manager */
|
|
756
|
-
credentialSecretIdentifier?: string;
|
|
757
|
-
/** ID of the Control Tower that Cloud Account is connected */
|
|
758
|
-
controlTowerId?: string;
|
|
759
|
-
};
|
|
760
|
-
export type PaginatedResponseAdminCloudAccountDetails = {
|
|
761
|
-
data: AdminCloudAccountDetails[];
|
|
762
|
-
nextPage?: string;
|
|
763
|
-
prevPage?: string;
|
|
764
|
-
count: number;
|
|
765
|
-
};
|
|
766
|
-
export type DeleteCloudAccountResponse = {
|
|
767
|
-
cloudAccountId: Ulid;
|
|
768
|
-
/** The type of the cloud account */
|
|
769
|
-
cloudType: "CustomCloud" | "CloudServices";
|
|
770
|
-
/** If the type is 'CloudServices', the delete operation opens a support case in order to delete the account */
|
|
771
|
-
supportCaseId?: string;
|
|
772
|
-
};
|
|
773
|
-
/**
|
|
774
|
-
* Get a single case
|
|
775
|
-
*/
|
|
776
|
-
export declare function getCase({ jwtToken, id, pageNum, pageSize }: {
|
|
777
|
-
jwtToken: JwtToken;
|
|
778
|
-
id: number;
|
|
779
|
-
pageNum?: number;
|
|
780
|
-
pageSize?: number;
|
|
781
|
-
}, opts?: Oazapfts.RequestOpts): Promise<Case>;
|
|
782
|
-
/**
|
|
783
|
-
* Update a case
|
|
784
|
-
*/
|
|
785
|
-
export declare function updateCase({ jwtToken, id, caseUpdate }: {
|
|
786
|
-
jwtToken: JwtToken;
|
|
787
|
-
id: number;
|
|
788
|
-
caseUpdate: CaseUpdate;
|
|
789
|
-
}, opts?: Oazapfts.RequestOpts): Promise<Case>;
|
|
790
|
-
/**
|
|
791
|
-
* Get a single saving plan
|
|
792
|
-
*/
|
|
793
|
-
export declare function getSavingPlan({ id }: {
|
|
794
|
-
id: number;
|
|
795
|
-
}, opts?: Oazapfts.RequestOpts): Promise<SavingPlan>;
|
|
796
|
-
/**
|
|
797
|
-
* Update saving plan
|
|
798
|
-
*/
|
|
799
|
-
export declare function updateSavingPlan({ id, savingPlanUpdate }: {
|
|
800
|
-
id: number;
|
|
801
|
-
savingPlanUpdate: SavingPlanUpdate;
|
|
802
|
-
}, opts?: Oazapfts.RequestOpts): Promise<SavingPlan>;
|
|
803
|
-
/**
|
|
804
|
-
* Update a GuardRail
|
|
805
|
-
*/
|
|
806
|
-
export declare function updateGuardrail({ jwtToken, guardrailUpdate }: {
|
|
807
|
-
jwtToken: JwtToken;
|
|
808
|
-
guardrailUpdate: GuardrailUpdate;
|
|
809
|
-
}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
|
|
810
|
-
/**
|
|
811
|
-
* Create a GuardRail
|
|
812
|
-
*/
|
|
813
|
-
export declare function createGuardrail({ jwtToken, guardrailRequest }: {
|
|
814
|
-
jwtToken: JwtToken;
|
|
815
|
-
guardrailRequest: GuardrailRequest;
|
|
816
|
-
}, opts?: Oazapfts.RequestOpts): Promise<GuardrailDetails>;
|
|
817
|
-
/**
|
|
818
|
-
* Update a baseline
|
|
819
|
-
*/
|
|
820
|
-
export declare function updateBaseline({ baselineId, baselineUpdate }: {
|
|
821
|
-
baselineId: string;
|
|
822
|
-
baselineUpdate: BaselineUpdate;
|
|
823
|
-
}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
|
|
824
|
-
/**
|
|
825
|
-
* Retrieves billing account summaries
|
|
826
|
-
*/
|
|
827
|
-
export declare function listBillingAccounts({ jwtToken, stackSpotAccountId, showDeleted }: {
|
|
828
|
-
jwtToken: JwtToken;
|
|
829
|
-
stackSpotAccountId: string;
|
|
830
|
-
showDeleted?: boolean;
|
|
831
|
-
}, opts?: Oazapfts.RequestOpts): Promise<BillingAccountSummaryResponse>;
|
|
832
|
-
/**
|
|
833
|
-
* Create new billing account
|
|
834
|
-
*/
|
|
835
|
-
export declare function createBillingAccount({ jwtToken, billingAccountRequest }: {
|
|
836
|
-
jwtToken: JwtToken;
|
|
837
|
-
billingAccountRequest: BillingAccountRequest;
|
|
838
|
-
}, opts?: Oazapfts.RequestOpts): Promise<BillingAccountDetailsResponse>;
|
|
839
|
-
/**
|
|
840
|
-
* Retrieves cost and usage metrics for your account.
|
|
841
|
-
*/
|
|
842
|
-
export declare function processAllocationCostRequest({ jwtToken, allocationCostRequest }: {
|
|
843
|
-
jwtToken: JwtToken;
|
|
844
|
-
allocationCostRequest: AllocationCostRequest;
|
|
845
|
-
}, opts?: Oazapfts.RequestOpts): Promise<AllocationCostResponse>;
|
|
846
|
-
/**
|
|
847
|
-
* List support cases
|
|
848
|
-
*/
|
|
849
|
-
export declare function listCases({ jwtToken, sortBy, sortOrder, search, page, pageSize, visibility }: {
|
|
850
|
-
jwtToken: JwtToken;
|
|
851
|
-
sortBy?: string;
|
|
852
|
-
sortOrder?: string;
|
|
853
|
-
search?: string;
|
|
854
|
-
page?: number;
|
|
855
|
-
pageSize?: number;
|
|
856
|
-
visibility?: "AccountLevel" | "UserLevel";
|
|
857
|
-
}, opts?: Oazapfts.RequestOpts): Promise<ListCasesResponse>;
|
|
858
|
-
/**
|
|
859
|
-
* Create a support case
|
|
860
|
-
*/
|
|
861
|
-
export declare function createCase({ jwtToken, caseRequest }: {
|
|
862
|
-
jwtToken: JwtToken;
|
|
863
|
-
caseRequest: CaseRequest;
|
|
864
|
-
}, opts?: Oazapfts.RequestOpts): Promise<Case>;
|
|
865
|
-
/**
|
|
866
|
-
* Upload an attachment
|
|
867
|
-
*/
|
|
868
|
-
export declare function uploadAttachment({ jwtToken, attachmentUpload }: {
|
|
869
|
-
jwtToken: JwtToken;
|
|
870
|
-
attachmentUpload?: AttachmentUpload;
|
|
871
|
-
}, opts?: Oazapfts.RequestOpts): Promise<Attachment>;
|
|
872
|
-
/**
|
|
873
|
-
* Get list of saving plans
|
|
874
|
-
*/
|
|
875
|
-
export declare function getListOfSavingPlans({ sortBy, sortOrder, filter, page, pageSize }: {
|
|
876
|
-
sortBy?: string;
|
|
877
|
-
sortOrder?: string;
|
|
878
|
-
filter?: string;
|
|
879
|
-
page?: number;
|
|
880
|
-
pageSize?: number;
|
|
881
|
-
}, opts?: Oazapfts.RequestOpts): Promise<PaginatedResourceSavingPlanSummary>;
|
|
882
|
-
/**
|
|
883
|
-
* Create saving plan
|
|
884
|
-
*/
|
|
885
|
-
export declare function createSavingPlanByBudgetSaveType({ savingPlanRequest }: {
|
|
886
|
-
savingPlanRequest: SavingPlanRequest;
|
|
887
|
-
}, opts?: Oazapfts.RequestOpts): Promise<SavingPlan>;
|
|
888
|
-
/**
|
|
889
|
-
* Enable a GuardRail in any level
|
|
890
|
-
*/
|
|
891
|
-
export declare function enableGuardrail({ jwtToken, account, workspace, env, enable, guardrailId }: {
|
|
892
|
-
jwtToken: JwtToken;
|
|
893
|
-
account: string;
|
|
894
|
-
workspace?: string;
|
|
895
|
-
env?: string;
|
|
896
|
-
enable: boolean;
|
|
897
|
-
guardrailId: string;
|
|
898
|
-
}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
|
|
899
|
-
/**
|
|
900
|
-
* Register a cloud offer for a Stackspot Account.
|
|
901
|
-
*/
|
|
902
|
-
export declare function registerOffer({ registerOfferRequest }: {
|
|
903
|
-
registerOfferRequest: RegisterOfferRequest;
|
|
904
|
-
}, opts?: Oazapfts.RequestOpts): Promise<"100 CONTINUE" | "101 SWITCHING_PROTOCOLS" | "102 PROCESSING" | "103 EARLY_HINTS" | "103 CHECKPOINT" | "200 OK" | "201 CREATED" | "202 ACCEPTED" | "203 NON_AUTHORITATIVE_INFORMATION" | "204 NO_CONTENT" | "205 RESET_CONTENT" | "206 PARTIAL_CONTENT" | "207 MULTI_STATUS" | "208 ALREADY_REPORTED" | "226 IM_USED" | "300 MULTIPLE_CHOICES" | "301 MOVED_PERMANENTLY" | "302 FOUND" | "302 MOVED_TEMPORARILY" | "303 SEE_OTHER" | "304 NOT_MODIFIED" | "305 USE_PROXY" | "307 TEMPORARY_REDIRECT" | "308 PERMANENT_REDIRECT" | "400 BAD_REQUEST" | "401 UNAUTHORIZED" | "402 PAYMENT_REQUIRED" | "403 FORBIDDEN" | "404 NOT_FOUND" | "405 METHOD_NOT_ALLOWED" | "406 NOT_ACCEPTABLE" | "407 PROXY_AUTHENTICATION_REQUIRED" | "408 REQUEST_TIMEOUT" | "409 CONFLICT" | "410 GONE" | "411 LENGTH_REQUIRED" | "412 PRECONDITION_FAILED" | "413 PAYLOAD_TOO_LARGE" | "413 REQUEST_ENTITY_TOO_LARGE" | "414 URI_TOO_LONG" | "414 REQUEST_URI_TOO_LONG" | "415 UNSUPPORTED_MEDIA_TYPE" | "416 REQUESTED_RANGE_NOT_SATISFIABLE" | "417 EXPECTATION_FAILED" | "418 I_AM_A_TEAPOT" | "419 INSUFFICIENT_SPACE_ON_RESOURCE" | "420 METHOD_FAILURE" | "421 DESTINATION_LOCKED" | "422 UNPROCESSABLE_ENTITY" | "423 LOCKED" | "424 FAILED_DEPENDENCY" | "425 TOO_EARLY" | "426 UPGRADE_REQUIRED" | "428 PRECONDITION_REQUIRED" | "429 TOO_MANY_REQUESTS" | "431 REQUEST_HEADER_FIELDS_TOO_LARGE" | "451 UNAVAILABLE_FOR_LEGAL_REASONS" | "500 INTERNAL_SERVER_ERROR" | "501 NOT_IMPLEMENTED" | "502 BAD_GATEWAY" | "503 SERVICE_UNAVAILABLE" | "504 GATEWAY_TIMEOUT" | "505 HTTP_VERSION_NOT_SUPPORTED" | "506 VARIANT_ALSO_NEGOTIATES" | "507 INSUFFICIENT_STORAGE" | "508 LOOP_DETECTED" | "509 BANDWIDTH_LIMIT_EXCEEDED" | "510 NOT_EXTENDED" | "511 NETWORK_AUTHENTICATION_REQUIRED">;
|
|
905
|
-
/**
|
|
906
|
-
* List all cloud accounts created for all workspaces
|
|
907
|
-
*/
|
|
908
|
-
export declare function listCloudAccounts({ jwtToken, sortBy, sortOrder, filter, page, pageSize, $type, environment, status }: {
|
|
909
|
-
jwtToken: JwtToken;
|
|
910
|
-
sortBy?: string;
|
|
911
|
-
sortOrder?: string;
|
|
912
|
-
filter?: string;
|
|
913
|
-
page?: number;
|
|
914
|
-
pageSize?: number;
|
|
915
|
-
$type?: "CustomCloud" | "CloudServices";
|
|
916
|
-
environment?: string;
|
|
917
|
-
status?: "Connecting" | "Connected" | "Disconnected" | "Failed" | "Unknown";
|
|
918
|
-
}, opts?: Oazapfts.RequestOpts): Promise<PaginatedResourceCloudAccountResponse>;
|
|
919
|
-
/**
|
|
920
|
-
* Connect a cloud account
|
|
921
|
-
*/
|
|
922
|
-
export declare function createCloudAccount({ jwtToken, connectAccountRequest }: {
|
|
923
|
-
jwtToken: JwtToken;
|
|
924
|
-
connectAccountRequest: ConnectAccountRequest;
|
|
925
|
-
}, opts?: Oazapfts.RequestOpts): Promise<CloudAccountDetails>;
|
|
926
|
-
/**
|
|
927
|
-
* Provision managed accounts in a workspace
|
|
928
|
-
*/
|
|
929
|
-
export declare function provisionManagedAccountsForWorkspace({ jwtToken, managedAccountProvisionRequest }: {
|
|
930
|
-
jwtToken: JwtToken;
|
|
931
|
-
managedAccountProvisionRequest: ManagedAccountProvisionRequest;
|
|
932
|
-
}, opts?: Oazapfts.RequestOpts): Promise<"100 CONTINUE" | "101 SWITCHING_PROTOCOLS" | "102 PROCESSING" | "103 EARLY_HINTS" | "103 CHECKPOINT" | "200 OK" | "201 CREATED" | "202 ACCEPTED" | "203 NON_AUTHORITATIVE_INFORMATION" | "204 NO_CONTENT" | "205 RESET_CONTENT" | "206 PARTIAL_CONTENT" | "207 MULTI_STATUS" | "208 ALREADY_REPORTED" | "226 IM_USED" | "300 MULTIPLE_CHOICES" | "301 MOVED_PERMANENTLY" | "302 FOUND" | "302 MOVED_TEMPORARILY" | "303 SEE_OTHER" | "304 NOT_MODIFIED" | "305 USE_PROXY" | "307 TEMPORARY_REDIRECT" | "308 PERMANENT_REDIRECT" | "400 BAD_REQUEST" | "401 UNAUTHORIZED" | "402 PAYMENT_REQUIRED" | "403 FORBIDDEN" | "404 NOT_FOUND" | "405 METHOD_NOT_ALLOWED" | "406 NOT_ACCEPTABLE" | "407 PROXY_AUTHENTICATION_REQUIRED" | "408 REQUEST_TIMEOUT" | "409 CONFLICT" | "410 GONE" | "411 LENGTH_REQUIRED" | "412 PRECONDITION_FAILED" | "413 PAYLOAD_TOO_LARGE" | "413 REQUEST_ENTITY_TOO_LARGE" | "414 URI_TOO_LONG" | "414 REQUEST_URI_TOO_LONG" | "415 UNSUPPORTED_MEDIA_TYPE" | "416 REQUESTED_RANGE_NOT_SATISFIABLE" | "417 EXPECTATION_FAILED" | "418 I_AM_A_TEAPOT" | "419 INSUFFICIENT_SPACE_ON_RESOURCE" | "420 METHOD_FAILURE" | "421 DESTINATION_LOCKED" | "422 UNPROCESSABLE_ENTITY" | "423 LOCKED" | "424 FAILED_DEPENDENCY" | "425 TOO_EARLY" | "426 UPGRADE_REQUIRED" | "428 PRECONDITION_REQUIRED" | "429 TOO_MANY_REQUESTS" | "431 REQUEST_HEADER_FIELDS_TOO_LARGE" | "451 UNAVAILABLE_FOR_LEGAL_REASONS" | "500 INTERNAL_SERVER_ERROR" | "501 NOT_IMPLEMENTED" | "502 BAD_GATEWAY" | "503 SERVICE_UNAVAILABLE" | "504 GATEWAY_TIMEOUT" | "505 HTTP_VERSION_NOT_SUPPORTED" | "506 VARIANT_ALSO_NEGOTIATES" | "507 INSUFFICIENT_STORAGE" | "508 LOOP_DETECTED" | "509 BANDWIDTH_LIMIT_EXCEEDED" | "510 NOT_EXTENDED" | "511 NETWORK_AUTHENTICATION_REQUIRED">;
|
|
933
|
-
/**
|
|
934
|
-
* Disconnect a Managed Account that was requested to disconnect via support case
|
|
935
|
-
*/
|
|
936
|
-
export declare function disconnectCloudAccountRequestedForDisconnect({ disconnectSupportCaseManagedAccountRequest }: {
|
|
937
|
-
disconnectSupportCaseManagedAccountRequest: DisconnectSupportCaseManagedAccountRequest;
|
|
938
|
-
}, opts?: Oazapfts.RequestOpts): Promise<DisconnectSupportCaseManagedAccountResponse[]>;
|
|
939
|
-
/**
|
|
940
|
-
* Get all relation between stackspot accounts and control towers
|
|
941
|
-
*/
|
|
942
|
-
export declare function getAllAccountTower({ stackspotAccountId }: {
|
|
943
|
-
stackspotAccountId?: string;
|
|
944
|
-
}, opts?: Oazapfts.RequestOpts): Promise<StackspotAccountTower[]>;
|
|
945
|
-
/**
|
|
946
|
-
* Add a Control Tower ID to a Stackspot Account that will be used in creation of a Managed Cloud Account
|
|
947
|
-
*/
|
|
948
|
-
export declare function createAccountTower({ stackspotAccountTowerRequest }: {
|
|
949
|
-
stackspotAccountTowerRequest: StackspotAccountTowerRequest;
|
|
950
|
-
}, opts?: Oazapfts.RequestOpts): Promise<CommonCreatedResponse>;
|
|
951
|
-
export declare function createNewContract({ createContractRequest }: {
|
|
952
|
-
createContractRequest: CreateContractRequest;
|
|
953
|
-
}, opts?: Oazapfts.RequestOpts): Promise<Contract>;
|
|
954
|
-
/**
|
|
955
|
-
* Links services to a Stackspot account, allowing users from that account to see resources in CRE
|
|
956
|
-
*/
|
|
957
|
-
export declare function linkResourceTypesToStackspotAccount({ linkResourceTypeToStackspotAccountRequest }: {
|
|
958
|
-
linkResourceTypeToStackspotAccountRequest: LinkResourceTypeToStackspotAccountRequest;
|
|
959
|
-
}, opts?: Oazapfts.RequestOpts): Promise<"100 CONTINUE" | "101 SWITCHING_PROTOCOLS" | "102 PROCESSING" | "103 EARLY_HINTS" | "103 CHECKPOINT" | "200 OK" | "201 CREATED" | "202 ACCEPTED" | "203 NON_AUTHORITATIVE_INFORMATION" | "204 NO_CONTENT" | "205 RESET_CONTENT" | "206 PARTIAL_CONTENT" | "207 MULTI_STATUS" | "208 ALREADY_REPORTED" | "226 IM_USED" | "300 MULTIPLE_CHOICES" | "301 MOVED_PERMANENTLY" | "302 FOUND" | "302 MOVED_TEMPORARILY" | "303 SEE_OTHER" | "304 NOT_MODIFIED" | "305 USE_PROXY" | "307 TEMPORARY_REDIRECT" | "308 PERMANENT_REDIRECT" | "400 BAD_REQUEST" | "401 UNAUTHORIZED" | "402 PAYMENT_REQUIRED" | "403 FORBIDDEN" | "404 NOT_FOUND" | "405 METHOD_NOT_ALLOWED" | "406 NOT_ACCEPTABLE" | "407 PROXY_AUTHENTICATION_REQUIRED" | "408 REQUEST_TIMEOUT" | "409 CONFLICT" | "410 GONE" | "411 LENGTH_REQUIRED" | "412 PRECONDITION_FAILED" | "413 PAYLOAD_TOO_LARGE" | "413 REQUEST_ENTITY_TOO_LARGE" | "414 URI_TOO_LONG" | "414 REQUEST_URI_TOO_LONG" | "415 UNSUPPORTED_MEDIA_TYPE" | "416 REQUESTED_RANGE_NOT_SATISFIABLE" | "417 EXPECTATION_FAILED" | "418 I_AM_A_TEAPOT" | "419 INSUFFICIENT_SPACE_ON_RESOURCE" | "420 METHOD_FAILURE" | "421 DESTINATION_LOCKED" | "422 UNPROCESSABLE_ENTITY" | "423 LOCKED" | "424 FAILED_DEPENDENCY" | "425 TOO_EARLY" | "426 UPGRADE_REQUIRED" | "428 PRECONDITION_REQUIRED" | "429 TOO_MANY_REQUESTS" | "431 REQUEST_HEADER_FIELDS_TOO_LARGE" | "451 UNAVAILABLE_FOR_LEGAL_REASONS" | "500 INTERNAL_SERVER_ERROR" | "501 NOT_IMPLEMENTED" | "502 BAD_GATEWAY" | "503 SERVICE_UNAVAILABLE" | "504 GATEWAY_TIMEOUT" | "505 HTTP_VERSION_NOT_SUPPORTED" | "506 VARIANT_ALSO_NEGOTIATES" | "507 INSUFFICIENT_STORAGE" | "508 LOOP_DETECTED" | "509 BANDWIDTH_LIMIT_EXCEEDED" | "510 NOT_EXTENDED" | "511 NETWORK_AUTHENTICATION_REQUIRED">;
|
|
960
|
-
/**
|
|
961
|
-
*
|
|
962
|
-
* Updates Managed Account related information. If the account is of CustomCloud type, it changes to CloudServices
|
|
963
|
-
* (managed account type).
|
|
964
|
-
*
|
|
965
|
-
*/
|
|
966
|
-
export declare function updateManagedInfo({ updateManagedInfoRequest }: {
|
|
967
|
-
updateManagedInfoRequest: UpdateManagedInfoRequest;
|
|
968
|
-
}, opts?: Oazapfts.RequestOpts): Promise<UpdatedCloudAccountResponse>;
|
|
969
|
-
/**
|
|
970
|
-
* Disconnect a Cloud Account
|
|
971
|
-
*/
|
|
972
|
-
export declare function disconnectCloudAccountById({ disconnectCloudAccountRequest }: {
|
|
973
|
-
disconnectCloudAccountRequest: DisconnectCloudAccountRequest;
|
|
974
|
-
}, opts?: Oazapfts.RequestOpts): Promise<UpdatedCloudAccountResponse>;
|
|
975
|
-
/**
|
|
976
|
-
* Return all baseline registered
|
|
977
|
-
*/
|
|
978
|
-
export declare function getBaselines(opts?: Oazapfts.RequestOpts): Promise<BaselineResponse[]>;
|
|
979
|
-
/**
|
|
980
|
-
* Create a baseline
|
|
981
|
-
*/
|
|
982
|
-
export declare function createBaseline({ baselineRequest }: {
|
|
983
|
-
baselineRequest: BaselineRequest;
|
|
984
|
-
}, opts?: Oazapfts.RequestOpts): Promise<BaselineDetails>;
|
|
985
|
-
/**
|
|
986
|
-
* Retrieves details from a billing account
|
|
987
|
-
*/
|
|
988
|
-
export declare function getBillingAccountById({ jwtToken, stackSpotAccountId, billingAccountId }: {
|
|
989
|
-
jwtToken: JwtToken;
|
|
990
|
-
stackSpotAccountId: string;
|
|
991
|
-
billingAccountId: string;
|
|
992
|
-
}, opts?: Oazapfts.RequestOpts): Promise<BillingAccountDetailsResponse>;
|
|
993
|
-
/**
|
|
994
|
-
* Delete a billing account
|
|
995
|
-
*/
|
|
996
|
-
export declare function deleteBillingAccountById({ jwtToken, stackSpotAccountId, billingAccountId }: {
|
|
997
|
-
jwtToken: JwtToken;
|
|
998
|
-
stackSpotAccountId: string;
|
|
999
|
-
billingAccountId: string;
|
|
1000
|
-
}, opts?: Oazapfts.RequestOpts): Promise<BillingAccountDetailsResponse>;
|
|
1001
|
-
/**
|
|
1002
|
-
* Get form fields and information
|
|
1003
|
-
*/
|
|
1004
|
-
export declare function getFormField(opts?: Oazapfts.RequestOpts): Promise<SupportFormFieldResponse>;
|
|
1005
|
-
/**
|
|
1006
|
-
* Get an attachment file
|
|
1007
|
-
*/
|
|
1008
|
-
export declare function getAttachment({ jwtToken, id }: {
|
|
1009
|
-
jwtToken: JwtToken;
|
|
1010
|
-
id: string;
|
|
1011
|
-
}, opts?: Oazapfts.RequestOpts): Promise<AttachmentBase64>;
|
|
1012
|
-
export declare function healthz(opts?: Oazapfts.RequestOpts): Promise<HealthComponent>;
|
|
1013
|
-
/**
|
|
1014
|
-
* Get all GuardRails
|
|
1015
|
-
*/
|
|
1016
|
-
export declare function getGuardrails({ jwtToken, account, workspace, env }: {
|
|
1017
|
-
jwtToken: JwtToken;
|
|
1018
|
-
account: string;
|
|
1019
|
-
workspace?: string;
|
|
1020
|
-
env?: string;
|
|
1021
|
-
}, opts?: Oazapfts.RequestOpts): Promise<GroupedGuardrailResponse[]>;
|
|
1022
|
-
/**
|
|
1023
|
-
* Get overview of costs, with current month, last month and three last month
|
|
1024
|
-
*/
|
|
1025
|
-
export declare function getCostOverview({ jwtToken, sortBy, sortOrder }: {
|
|
1026
|
-
jwtToken: JwtToken;
|
|
1027
|
-
sortBy?: string;
|
|
1028
|
-
sortOrder?: string;
|
|
1029
|
-
}, opts?: Oazapfts.RequestOpts): Promise<CostOverview>;
|
|
1030
|
-
export declare function downloadCsvFiles({ jwtToken, year, month }: {
|
|
1031
|
-
jwtToken: JwtToken;
|
|
1032
|
-
year: number;
|
|
1033
|
-
month: number;
|
|
1034
|
-
}, opts?: Oazapfts.RequestOpts): Promise<AttachmentBase64>;
|
|
1035
|
-
/**
|
|
1036
|
-
* List all tags.
|
|
1037
|
-
*/
|
|
1038
|
-
export declare function getAllTags({ stackspotAccountId }: {
|
|
1039
|
-
stackspotAccountId: string;
|
|
1040
|
-
}, opts?: Oazapfts.RequestOpts): Promise<string[]>;
|
|
1041
|
-
/**
|
|
1042
|
-
* lists all subTags of a given tag with their respective costs.
|
|
1043
|
-
*/
|
|
1044
|
-
export declare function getAllocationCostTagValues({ jwtToken, masterAccount, tag, startDate, endDate, sort, page, pageSize }: {
|
|
1045
|
-
jwtToken: JwtToken;
|
|
1046
|
-
masterAccount: string;
|
|
1047
|
-
tag: string;
|
|
1048
|
-
startDate: string;
|
|
1049
|
-
endDate: string;
|
|
1050
|
-
sort?: ("NAME_ASC" | "NAME_DESC" | "COST_VALUE_ASC" | "COST_VALUE_DESC")[];
|
|
1051
|
-
page?: number;
|
|
1052
|
-
pageSize?: number;
|
|
1053
|
-
}, opts?: Oazapfts.RequestOpts): Promise<PaginatedResponseAllocationCost>;
|
|
1054
|
-
/**
|
|
1055
|
-
* List all services of a subtag. Each service contains name and cost value.
|
|
1056
|
-
*/
|
|
1057
|
-
export declare function getAllocationCostServices({ jwtToken, masterAccount, tag, tagValueName, startDate, endDate, sort, page, pageSize }: {
|
|
1058
|
-
jwtToken: JwtToken;
|
|
1059
|
-
masterAccount: string;
|
|
1060
|
-
tag: string;
|
|
1061
|
-
tagValueName: string;
|
|
1062
|
-
startDate: string;
|
|
1063
|
-
endDate: string;
|
|
1064
|
-
sort?: ("NAME_ASC" | "NAME_DESC" | "COST_VALUE_ASC" | "COST_VALUE_DESC")[];
|
|
1065
|
-
page?: number;
|
|
1066
|
-
pageSize?: number;
|
|
1067
|
-
}, opts?: Oazapfts.RequestOpts): Promise<PaginatedResponseAllocationCost>;
|
|
1068
|
-
/**
|
|
1069
|
-
* list service details
|
|
1070
|
-
*/
|
|
1071
|
-
export declare function getAllocationCostServiceDetails({ jwtToken, masterAccount, tag, tagValueName, serviceName, startDate, endDate, $type, filter, page, pageSize, sort }: {
|
|
1072
|
-
jwtToken: JwtToken;
|
|
1073
|
-
masterAccount: string;
|
|
1074
|
-
tag: string;
|
|
1075
|
-
tagValueName: string;
|
|
1076
|
-
serviceName: string;
|
|
1077
|
-
startDate: string;
|
|
1078
|
-
endDate: string;
|
|
1079
|
-
$type: string;
|
|
1080
|
-
filter?: string[];
|
|
1081
|
-
page?: number;
|
|
1082
|
-
pageSize?: number;
|
|
1083
|
-
sort?: ("NAME_ASC" | "NAME_DESC" | "COST_VALUE_ASC" | "COST_VALUE_DESC")[];
|
|
1084
|
-
}, opts?: Oazapfts.RequestOpts): Promise<PaginatedResponseAllocationCostDetails>;
|
|
1085
|
-
/**
|
|
1086
|
-
* list all master accounts
|
|
1087
|
-
*/
|
|
1088
|
-
export declare function getAllMasterAccount({ stackspotAccountId }: {
|
|
1089
|
-
stackspotAccountId: string;
|
|
1090
|
-
}, opts?: Oazapfts.RequestOpts): Promise<string[]>;
|
|
1091
|
-
/**
|
|
1092
|
-
* list filters related to the type
|
|
1093
|
-
*/
|
|
1094
|
-
export declare function getAllocationCostFilters({ jwtToken, $type }: {
|
|
1095
|
-
jwtToken: JwtToken;
|
|
1096
|
-
$type: "SUB_ACCOUNT_ID" | "REGION";
|
|
1097
|
-
}, opts?: Oazapfts.RequestOpts): Promise<string[]>;
|
|
1098
|
-
/**
|
|
1099
|
-
* returns the detailed csv with the masterAccount CUR information
|
|
1100
|
-
*/
|
|
1101
|
-
export declare function getAllocationCostCsv({ jwtToken, stackspotAccountId, masterAccount, startDate, endDate }: {
|
|
1102
|
-
jwtToken: JwtToken;
|
|
1103
|
-
stackspotAccountId: string;
|
|
1104
|
-
masterAccount: string;
|
|
1105
|
-
startDate: string;
|
|
1106
|
-
endDate: string;
|
|
1107
|
-
}, opts?: Oazapfts.RequestOpts): Promise<AttachmentBase64>;
|
|
1108
|
-
/**
|
|
1109
|
-
* List Instances of a particular Service Resource running in a Workspace
|
|
1110
|
-
*/
|
|
1111
|
-
export declare function listInstances({ jwtToken, workspaceId, resourceId, pageToken, search }: {
|
|
1112
|
-
jwtToken: JwtToken;
|
|
1113
|
-
workspaceId: string;
|
|
1114
|
-
resourceId: string;
|
|
1115
|
-
pageToken?: string;
|
|
1116
|
-
search?: string;
|
|
1117
|
-
}, opts?: Oazapfts.RequestOpts): Promise<ManagedResourceList>;
|
|
1118
|
-
/**
|
|
1119
|
-
* List Managed Services
|
|
1120
|
-
*/
|
|
1121
|
-
export declare function listServices({ jwtToken }: {
|
|
1122
|
-
jwtToken: JwtToken;
|
|
1123
|
-
}, opts?: Oazapfts.RequestOpts): Promise<ManagedService[]>;
|
|
1124
|
-
/**
|
|
1125
|
-
* A detailed description of a particular Instance
|
|
1126
|
-
*/
|
|
1127
|
-
export declare function getInstanceDetails({ jwtToken, cloudAccountId, resourceId, instanceId }: {
|
|
1128
|
-
jwtToken: JwtToken;
|
|
1129
|
-
cloudAccountId: string;
|
|
1130
|
-
resourceId: string;
|
|
1131
|
-
instanceId: string;
|
|
1132
|
-
}, opts?: Oazapfts.RequestOpts): Promise<object>;
|
|
1133
|
-
/**
|
|
1134
|
-
* Get the cloud offer of a Stackspot Account.
|
|
1135
|
-
*/
|
|
1136
|
-
export declare function getOfferOfAccount({ id }: {
|
|
1137
|
-
id: string;
|
|
1138
|
-
}, opts?: Oazapfts.RequestOpts): Promise<CloudOfferResponse>;
|
|
1139
|
-
/**
|
|
1140
|
-
* Get the external-id for the given Cloud Account ID.
|
|
1141
|
-
*/
|
|
1142
|
-
export declare function getCloudAccountExternalId({ cloudAccountId }: {
|
|
1143
|
-
cloudAccountId: string;
|
|
1144
|
-
}, opts?: Oazapfts.RequestOpts): Promise<string>;
|
|
1145
|
-
/**
|
|
1146
|
-
* Get the cloud account workflow of a workspace environment
|
|
1147
|
-
*/
|
|
1148
|
-
export declare function getProvisionWorkflowInWorkspace({ jwtToken, workspaceId }: {
|
|
1149
|
-
jwtToken: JwtToken;
|
|
1150
|
-
workspaceId: string;
|
|
1151
|
-
}, opts?: Oazapfts.RequestOpts): Promise<Workflow>;
|
|
1152
|
-
/**
|
|
1153
|
-
* Get a cloud account connected to a workspace environment
|
|
1154
|
-
*/
|
|
1155
|
-
export declare function getCloudAccountByEnvironment({ accountId, workspaceId, environmentId }: {
|
|
1156
|
-
accountId: string;
|
|
1157
|
-
workspaceId: string;
|
|
1158
|
-
environmentId: string;
|
|
1159
|
-
}, opts?: Oazapfts.RequestOpts): Promise<CloudAccountWithCredentialResponse>;
|
|
1160
|
-
/**
|
|
1161
|
-
* Get a list of cloud accounts connected to a workspace
|
|
1162
|
-
*/
|
|
1163
|
-
export declare function getCloudAccountByWorkspace({ jwtToken, accountId, id }: {
|
|
1164
|
-
jwtToken: JwtToken;
|
|
1165
|
-
accountId?: string;
|
|
1166
|
-
id: string;
|
|
1167
|
-
}, opts?: Oazapfts.RequestOpts): Promise<CloudAccountDetails[]>;
|
|
1168
|
-
/**
|
|
1169
|
-
* Get all available templates for Managed Cloud
|
|
1170
|
-
*/
|
|
1171
|
-
export declare function getManagedCloudTemplate(opts?: Oazapfts.RequestOpts): Promise<ManagedAccountTemplateResponse[]>;
|
|
1172
|
-
/**
|
|
1173
|
-
* Get all available regions for Managed Cloud
|
|
1174
|
-
*/
|
|
1175
|
-
export declare function getManagedCloudRegion(opts?: Oazapfts.RequestOpts): Promise<ManagedAccountRegionResponse[]>;
|
|
1176
|
-
/**
|
|
1177
|
-
* Get pages alerts from workspace and environment. That alerts can be filtered
|
|
1178
|
-
*/
|
|
1179
|
-
export declare function getAlerts({ jwtToken, workspace, env, pillar, severity, status, search, sort, page, pageSize }: {
|
|
1180
|
-
jwtToken: JwtToken;
|
|
1181
|
-
workspace: string;
|
|
1182
|
-
env: string;
|
|
1183
|
-
pillar?: "SECURITY" | "COST_OPTIMIZATION" | "RELIABILITY";
|
|
1184
|
-
severity?: "LOW" | "MEDIUM" | "HIGH" | "MANDATORY";
|
|
1185
|
-
status?: "PENDING" | "NOT_APPLICABLE" | "COMPLETED";
|
|
1186
|
-
search?: string;
|
|
1187
|
-
sort?: ("STATUS_ASC" | "STATUS_DESC" | "POLICIES_ASC" | "POLICIES_DESC" | "PILLAR_ASC" | "PILLAR_DESC" | "SEVERITY_ASC" | "SEVERITY_DESC")[];
|
|
1188
|
-
page?: number;
|
|
1189
|
-
pageSize?: number;
|
|
1190
|
-
}, opts?: Oazapfts.RequestOpts): Promise<PaginatedResponseAlert>;
|
|
1191
|
-
export declare function downloadDataByAccountId({ stackspotAccountId, year, month }: {
|
|
1192
|
-
stackspotAccountId: string;
|
|
1193
|
-
year: number;
|
|
1194
|
-
month: number;
|
|
1195
|
-
}, opts?: Oazapfts.RequestOpts): Promise<AttachmentBase64>;
|
|
1196
|
-
/**
|
|
1197
|
-
* List available services
|
|
1198
|
-
*/
|
|
1199
|
-
export declare function listServices1(opts?: Oazapfts.RequestOpts): Promise<ServiceSummary[]>;
|
|
1200
|
-
/**
|
|
1201
|
-
* Get Cloud Account data with details
|
|
1202
|
-
*/
|
|
1203
|
-
export declare function getCloudAccount({ stackspotAccountId, workspaceId, environmentId, provider, $type, status }: {
|
|
1204
|
-
stackspotAccountId?: string;
|
|
1205
|
-
workspaceId?: string;
|
|
1206
|
-
environmentId?: string;
|
|
1207
|
-
provider?: "AWS" | "Azure";
|
|
1208
|
-
$type?: "CustomCloud" | "CloudServices";
|
|
1209
|
-
status?: "Connecting" | "Connected" | "Disconnected" | "Failed" | "Unknown";
|
|
1210
|
-
}, opts?: Oazapfts.RequestOpts): Promise<PaginatedResponseAdminCloudAccountDetails>;
|
|
1211
|
-
/**
|
|
1212
|
-
* Delete a cloud account.
|
|
1213
|
-
*/
|
|
1214
|
-
export declare function deleteCloudAccountFromEnvironment({ jwtToken, id }: {
|
|
1215
|
-
jwtToken: JwtToken;
|
|
1216
|
-
id: string;
|
|
1217
|
-
}, opts?: Oazapfts.RequestOpts): Promise<DeleteCloudAccountResponse>;
|
|
1218
|
-
/**
|
|
1219
|
-
*
|
|
1220
|
-
* Delete all accounts in a workspace.
|
|
1221
|
-
*
|
|
1222
|
-
*/
|
|
1223
|
-
export declare function deleteManagedAccountsFromWorkspace({ jwtToken, workspaceId }: {
|
|
1224
|
-
jwtToken: JwtToken;
|
|
1225
|
-
workspaceId: string;
|
|
1226
|
-
}, opts?: Oazapfts.RequestOpts): Promise<DeleteCloudAccountResponse>;
|
|
1227
|
-
/**
|
|
1228
|
-
* Delete a relation between control tower and stackspot account
|
|
1229
|
-
*/
|
|
1230
|
-
export declare function deleteAccountTower({ id }: {
|
|
1231
|
-
id: string;
|
|
1232
|
-
}, opts?: Oazapfts.RequestOpts): Promise<"100 CONTINUE" | "101 SWITCHING_PROTOCOLS" | "102 PROCESSING" | "103 EARLY_HINTS" | "103 CHECKPOINT" | "200 OK" | "201 CREATED" | "202 ACCEPTED" | "203 NON_AUTHORITATIVE_INFORMATION" | "204 NO_CONTENT" | "205 RESET_CONTENT" | "206 PARTIAL_CONTENT" | "207 MULTI_STATUS" | "208 ALREADY_REPORTED" | "226 IM_USED" | "300 MULTIPLE_CHOICES" | "301 MOVED_PERMANENTLY" | "302 FOUND" | "302 MOVED_TEMPORARILY" | "303 SEE_OTHER" | "304 NOT_MODIFIED" | "305 USE_PROXY" | "307 TEMPORARY_REDIRECT" | "308 PERMANENT_REDIRECT" | "400 BAD_REQUEST" | "401 UNAUTHORIZED" | "402 PAYMENT_REQUIRED" | "403 FORBIDDEN" | "404 NOT_FOUND" | "405 METHOD_NOT_ALLOWED" | "406 NOT_ACCEPTABLE" | "407 PROXY_AUTHENTICATION_REQUIRED" | "408 REQUEST_TIMEOUT" | "409 CONFLICT" | "410 GONE" | "411 LENGTH_REQUIRED" | "412 PRECONDITION_FAILED" | "413 PAYLOAD_TOO_LARGE" | "413 REQUEST_ENTITY_TOO_LARGE" | "414 URI_TOO_LONG" | "414 REQUEST_URI_TOO_LONG" | "415 UNSUPPORTED_MEDIA_TYPE" | "416 REQUESTED_RANGE_NOT_SATISFIABLE" | "417 EXPECTATION_FAILED" | "418 I_AM_A_TEAPOT" | "419 INSUFFICIENT_SPACE_ON_RESOURCE" | "420 METHOD_FAILURE" | "421 DESTINATION_LOCKED" | "422 UNPROCESSABLE_ENTITY" | "423 LOCKED" | "424 FAILED_DEPENDENCY" | "425 TOO_EARLY" | "426 UPGRADE_REQUIRED" | "428 PRECONDITION_REQUIRED" | "429 TOO_MANY_REQUESTS" | "431 REQUEST_HEADER_FIELDS_TOO_LARGE" | "451 UNAVAILABLE_FOR_LEGAL_REASONS" | "500 INTERNAL_SERVER_ERROR" | "501 NOT_IMPLEMENTED" | "502 BAD_GATEWAY" | "503 SERVICE_UNAVAILABLE" | "504 GATEWAY_TIMEOUT" | "505 HTTP_VERSION_NOT_SUPPORTED" | "506 VARIANT_ALSO_NEGOTIATES" | "507 INSUFFICIENT_STORAGE" | "508 LOOP_DETECTED" | "509 BANDWIDTH_LIMIT_EXCEEDED" | "510 NOT_EXTENDED" | "511 NETWORK_AUTHENTICATION_REQUIRED">;
|
|
1233
|
-
//# sourceMappingURL=cloudServices.d.ts.map
|