@scaleway/sdk 2.73.0 → 2.74.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/api/account/v3/index.gen.d.ts +1 -1
- package/dist/api/account/v3/marshalling.gen.cjs +94 -65
- package/dist/api/account/v3/marshalling.gen.js +94 -65
- package/dist/api/account/v3/types.gen.d.ts +79 -61
- package/dist/api/baremetal/v1/types.gen.d.ts +1 -1
- package/dist/api/cockpit/v1/api.gen.cjs +35 -3
- package/dist/api/cockpit/v1/api.gen.d.ts +17 -5
- package/dist/api/cockpit/v1/api.gen.js +36 -4
- package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
- package/dist/api/cockpit/v1/marshalling.gen.cjs +23 -0
- package/dist/api/cockpit/v1/marshalling.gen.d.ts +3 -1
- package/dist/api/cockpit/v1/marshalling.gen.js +23 -0
- package/dist/api/cockpit/v1/types.gen.d.ts +63 -2
- package/dist/api/dedibox/v1/types.gen.d.ts +3 -3
- package/dist/api/edge_services/v1beta1/api.gen.cjs +41 -22
- package/dist/api/edge_services/v1beta1/api.gen.d.ts +3 -2
- package/dist/api/edge_services/v1beta1/api.gen.js +41 -22
- package/dist/api/edge_services/v1beta1/index.gen.d.ts +1 -1
- package/dist/api/edge_services/v1beta1/types.gen.d.ts +7 -0
- package/dist/api/file/index.gen.cjs +4 -0
- package/dist/api/file/index.gen.d.ts +5 -0
- package/dist/api/file/index.gen.js +4 -0
- package/dist/api/file/v1alpha1/api.gen.cjs +142 -0
- package/dist/api/file/v1alpha1/api.gen.d.ts +73 -0
- package/dist/api/file/v1alpha1/api.gen.js +142 -0
- package/dist/api/file/v1alpha1/content.gen.cjs +7 -0
- package/dist/api/file/v1alpha1/content.gen.d.ts +3 -0
- package/dist/api/file/v1alpha1/content.gen.js +7 -0
- package/dist/api/file/v1alpha1/index.gen.cjs +8 -0
- package/dist/api/file/v1alpha1/index.gen.d.ts +4 -0
- package/dist/api/file/v1alpha1/index.gen.js +8 -0
- package/dist/api/file/v1alpha1/marshalling.gen.cjs +77 -0
- package/dist/api/file/v1alpha1/marshalling.gen.d.ts +7 -0
- package/dist/api/file/v1alpha1/marshalling.gen.js +77 -0
- package/dist/api/file/v1alpha1/types.gen.d.ts +239 -0
- package/dist/api/file/v1alpha1/validation-rules.gen.cjs +40 -0
- package/dist/api/file/v1alpha1/validation-rules.gen.d.ts +34 -0
- package/dist/api/file/v1alpha1/validation-rules.gen.js +40 -0
- package/dist/api/function/v1beta1/types.gen.d.ts +6 -6
- package/dist/api/iam/v1alpha1/api.gen.cjs +4 -4
- package/dist/api/iam/v1alpha1/api.gen.d.ts +4 -4
- package/dist/api/iam/v1alpha1/api.gen.js +4 -4
- package/dist/api/iam/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/index.gen.d.ts +3 -1
- package/dist/api/inference/v1beta1/api.gen.cjs +1 -1
- package/dist/api/inference/v1beta1/api.gen.d.ts +1 -1
- package/dist/api/inference/v1beta1/api.gen.js +1 -1
- package/dist/api/instance/v1/marshalling.gen.cjs +4 -1
- package/dist/api/instance/v1/marshalling.gen.js +4 -1
- package/dist/api/instance/v1/types.gen.d.ts +16 -1
- package/dist/api/interlink/v1beta1/api.gen.cjs +1 -1
- package/dist/api/interlink/v1beta1/api.gen.d.ts +1 -1
- package/dist/api/interlink/v1beta1/api.gen.js +1 -1
- package/dist/api/iot/v1/types.gen.d.ts +1 -1
- package/dist/api/lb/v1/marshalling.gen.cjs +4 -2
- package/dist/api/lb/v1/marshalling.gen.js +4 -2
- package/dist/api/lb/v1/types.gen.d.ts +4 -0
- package/dist/api/mongodb/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/product_catalog/index.gen.cjs +4 -0
- package/dist/api/product_catalog/index.gen.d.ts +5 -0
- package/dist/api/product_catalog/index.gen.js +4 -0
- package/dist/api/product_catalog/v2alpha1/api.gen.cjs +36 -0
- package/dist/api/product_catalog/v2alpha1/api.gen.d.ts +18 -0
- package/dist/api/product_catalog/v2alpha1/api.gen.js +36 -0
- package/dist/api/product_catalog/v2alpha1/index.gen.cjs +6 -0
- package/dist/api/product_catalog/v2alpha1/index.gen.d.ts +3 -0
- package/dist/api/product_catalog/v2alpha1/index.gen.js +6 -0
- package/dist/api/product_catalog/v2alpha1/marshalling.gen.cjs +230 -0
- package/dist/api/product_catalog/v2alpha1/marshalling.gen.d.ts +2 -0
- package/dist/api/product_catalog/v2alpha1/marshalling.gen.js +230 -0
- package/dist/api/product_catalog/v2alpha1/types.gen.d.ts +293 -0
- package/dist/api/product_catalog/v2alpha1/validation-rules.gen.cjs +11 -0
- package/dist/api/product_catalog/v2alpha1/validation-rules.gen.d.ts +8 -0
- package/dist/api/product_catalog/v2alpha1/validation-rules.gen.js +11 -0
- package/dist/api/qaas/v1alpha1/types.gen.d.ts +2 -2
- package/dist/api/rdb/v1/api.gen.cjs +1 -1
- package/dist/api/rdb/v1/api.gen.d.ts +1 -1
- package/dist/api/rdb/v1/api.gen.js +1 -1
- package/dist/api/rdb/v1/types.gen.d.ts +2 -2
- package/dist/api/redis/v1/api.gen.cjs +1 -1
- package/dist/api/redis/v1/api.gen.d.ts +1 -1
- package/dist/api/redis/v1/api.gen.js +1 -1
- package/dist/api/registry/v1/types.gen.d.ts +1 -1
- package/dist/api/vpcgw/v1/api.gen.cjs +37 -0
- package/dist/api/vpcgw/v1/api.gen.d.ts +37 -0
- package/dist/api/vpcgw/v1/api.gen.js +37 -0
- package/dist/index.cjs +36 -32
- package/dist/index.js +36 -32
- package/package.json +2 -2
|
@@ -189,7 +189,7 @@ class GlobalAPI extends api.API {
|
|
|
189
189
|
);
|
|
190
190
|
/**
|
|
191
191
|
* List plan types. Retrieve a list of available pricing plan types.
|
|
192
|
-
Deprecated
|
|
192
|
+
Deprecated: retention is now managed at the data source level.
|
|
193
193
|
*
|
|
194
194
|
* @deprecated
|
|
195
195
|
* @param request - The request {@link GlobalApiListPlansRequest}
|
|
@@ -198,7 +198,7 @@ class GlobalAPI extends api.API {
|
|
|
198
198
|
listPlans = (request = {}) => resourcePaginator.enrichForPagination("plans", this.pageOfListPlans, request);
|
|
199
199
|
/**
|
|
200
200
|
* Apply a pricing plan. Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
|
|
201
|
-
Deprecated
|
|
201
|
+
Deprecated: retention is now managed at the data source level.
|
|
202
202
|
*
|
|
203
203
|
* @deprecated
|
|
204
204
|
* @param request - The request {@link GlobalApiSelectPlanRequest}
|
|
@@ -217,7 +217,7 @@ class GlobalAPI extends api.API {
|
|
|
217
217
|
);
|
|
218
218
|
/**
|
|
219
219
|
* Get current plan. Retrieve a pricing plan for the given Project, specified by the ID of the Project.
|
|
220
|
-
Deprecated
|
|
220
|
+
Deprecated: retention is now managed at the data source level.
|
|
221
221
|
*
|
|
222
222
|
* @deprecated
|
|
223
223
|
* @param request - The request {@link GlobalApiGetCurrentPlanRequest}
|
|
@@ -635,6 +635,38 @@ class RegionalAPI extends api.API {
|
|
|
635
635
|
},
|
|
636
636
|
marshalling_gen.unmarshalAlertManager
|
|
637
637
|
);
|
|
638
|
+
/**
|
|
639
|
+
* Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.. Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.
|
|
640
|
+
*
|
|
641
|
+
* @param request - The request {@link RegionalApiEnableAlertRulesRequest}
|
|
642
|
+
*/
|
|
643
|
+
enableAlertRules = (request = {}) => this.client.fetch({
|
|
644
|
+
body: JSON.stringify(
|
|
645
|
+
marshalling_gen.marshalRegionalApiEnableAlertRulesRequest(
|
|
646
|
+
request,
|
|
647
|
+
this.client.settings
|
|
648
|
+
)
|
|
649
|
+
),
|
|
650
|
+
headers: jsonContentHeaders,
|
|
651
|
+
method: "POST",
|
|
652
|
+
path: `/cockpit/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/enable-alert-rules`
|
|
653
|
+
});
|
|
654
|
+
/**
|
|
655
|
+
* Disable preconfigured alert rules. Disable alert rules from the list of available preconfigured rules.. Disable preconfigured alert rules. Disable alert rules from the list of available preconfigured rules.
|
|
656
|
+
*
|
|
657
|
+
* @param request - The request {@link RegionalApiDisableAlertRulesRequest}
|
|
658
|
+
*/
|
|
659
|
+
disableAlertRules = (request = {}) => this.client.fetch({
|
|
660
|
+
body: JSON.stringify(
|
|
661
|
+
marshalling_gen.marshalRegionalApiDisableAlertRulesRequest(
|
|
662
|
+
request,
|
|
663
|
+
this.client.settings
|
|
664
|
+
)
|
|
665
|
+
),
|
|
666
|
+
headers: jsonContentHeaders,
|
|
667
|
+
method: "POST",
|
|
668
|
+
path: `/cockpit/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/disable-alert-rules`
|
|
669
|
+
});
|
|
638
670
|
/**
|
|
639
671
|
* Trigger a test alert. Send a test alert to the Alert manager to make sure your contact points get notified.
|
|
640
672
|
*
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { API as ParentAPI } from '@scaleway/sdk-client';
|
|
2
2
|
import type { Region as ScwRegion } from '@scaleway/sdk-client';
|
|
3
|
-
import type { AlertManager, ContactPoint, DataSource, GetConfigResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
|
|
3
|
+
import type { AlertManager, ContactPoint, DataSource, GetConfigResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Cockpit Global API.
|
|
6
6
|
|
|
7
|
-
The Cockpit Global API allows you to manage your Cockpit's Grafana
|
|
7
|
+
The Cockpit Global API allows you to manage your Cockpit's Grafana.
|
|
8
8
|
*/
|
|
9
9
|
export declare class GlobalAPI extends ParentAPI {
|
|
10
10
|
/**
|
|
@@ -75,7 +75,7 @@ export declare class GlobalAPI extends ParentAPI {
|
|
|
75
75
|
protected pageOfListPlans: (request?: Readonly<GlobalApiListPlansRequest>) => Promise<ListPlansResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* List plan types. Retrieve a list of available pricing plan types.
|
|
78
|
-
Deprecated
|
|
78
|
+
Deprecated: retention is now managed at the data source level.
|
|
79
79
|
*
|
|
80
80
|
* @deprecated
|
|
81
81
|
* @param request - The request {@link GlobalApiListPlansRequest}
|
|
@@ -87,7 +87,7 @@ export declare class GlobalAPI extends ParentAPI {
|
|
|
87
87
|
};
|
|
88
88
|
/**
|
|
89
89
|
* Apply a pricing plan. Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
|
|
90
|
-
Deprecated
|
|
90
|
+
Deprecated: retention is now managed at the data source level.
|
|
91
91
|
*
|
|
92
92
|
* @deprecated
|
|
93
93
|
* @param request - The request {@link GlobalApiSelectPlanRequest}
|
|
@@ -96,7 +96,7 @@ export declare class GlobalAPI extends ParentAPI {
|
|
|
96
96
|
selectPlan: (request?: Readonly<GlobalApiSelectPlanRequest>) => Promise<Plan>;
|
|
97
97
|
/**
|
|
98
98
|
* Get current plan. Retrieve a pricing plan for the given Project, specified by the ID of the Project.
|
|
99
|
-
Deprecated
|
|
99
|
+
Deprecated: retention is now managed at the data source level.
|
|
100
100
|
*
|
|
101
101
|
* @deprecated
|
|
102
102
|
* @param request - The request {@link GlobalApiGetCurrentPlanRequest}
|
|
@@ -272,6 +272,18 @@ export declare class RegionalAPI extends ParentAPI {
|
|
|
272
272
|
* @returns A Promise of AlertManager
|
|
273
273
|
*/
|
|
274
274
|
disableManagedAlerts: (request?: Readonly<RegionalApiDisableManagedAlertsRequest>) => Promise<AlertManager>;
|
|
275
|
+
/**
|
|
276
|
+
* Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.. Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.
|
|
277
|
+
*
|
|
278
|
+
* @param request - The request {@link RegionalApiEnableAlertRulesRequest}
|
|
279
|
+
*/
|
|
280
|
+
enableAlertRules: (request?: Readonly<RegionalApiEnableAlertRulesRequest>) => Promise<void>;
|
|
281
|
+
/**
|
|
282
|
+
* Disable preconfigured alert rules. Disable alert rules from the list of available preconfigured rules.. Disable preconfigured alert rules. Disable alert rules from the list of available preconfigured rules.
|
|
283
|
+
*
|
|
284
|
+
* @param request - The request {@link RegionalApiDisableAlertRulesRequest}
|
|
285
|
+
*/
|
|
286
|
+
disableAlertRules: (request?: Readonly<RegionalApiDisableAlertRulesRequest>) => Promise<void>;
|
|
275
287
|
/**
|
|
276
288
|
* Trigger a test alert. Send a test alert to the Alert manager to make sure your contact points get notified.
|
|
277
289
|
*
|
|
@@ -3,7 +3,7 @@ import { API as API$1 } from "../../../client/dist/scw/api.js";
|
|
|
3
3
|
import { urlParams, validatePathParam } from "../../../client/dist/helpers/marshalling.js";
|
|
4
4
|
import "../../../client/dist/vendor/base64/index.js";
|
|
5
5
|
import { enrichForPagination } from "../../../client/dist/scw/fetch/resource-paginator.js";
|
|
6
|
-
import { unmarshalGrafana, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalGlobalApiCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalGlobalApiResetGrafanaUserPasswordRequest, unmarshalListGrafanaProductDashboardsResponse, unmarshalGrafanaProductDashboard, unmarshalListPlansResponse, marshalGlobalApiSelectPlanRequest, unmarshalPlan, unmarshalGetConfigResponse, marshalRegionalApiCreateDataSourceRequest, unmarshalDataSource, unmarshalListDataSourcesResponse, marshalRegionalApiUpdateDataSourceRequest, unmarshalUsageOverview, marshalRegionalApiCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, unmarshalAlertManager, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiDisableAlertManagerRequest, marshalRegionalApiCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalRegionalApiUpdateContactPointRequest, marshalRegionalApiDeleteContactPointRequest, unmarshalListAlertsResponse, marshalRegionalApiEnableManagedAlertsRequest, marshalRegionalApiDisableManagedAlertsRequest, marshalRegionalApiTriggerTestAlertRequest } from "./marshalling.gen.js";
|
|
6
|
+
import { unmarshalGrafana, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalGlobalApiCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalGlobalApiResetGrafanaUserPasswordRequest, unmarshalListGrafanaProductDashboardsResponse, unmarshalGrafanaProductDashboard, unmarshalListPlansResponse, marshalGlobalApiSelectPlanRequest, unmarshalPlan, unmarshalGetConfigResponse, marshalRegionalApiCreateDataSourceRequest, unmarshalDataSource, unmarshalListDataSourcesResponse, marshalRegionalApiUpdateDataSourceRequest, unmarshalUsageOverview, marshalRegionalApiCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, unmarshalAlertManager, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiDisableAlertManagerRequest, marshalRegionalApiCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalRegionalApiUpdateContactPointRequest, marshalRegionalApiDeleteContactPointRequest, unmarshalListAlertsResponse, marshalRegionalApiEnableManagedAlertsRequest, marshalRegionalApiDisableManagedAlertsRequest, marshalRegionalApiEnableAlertRulesRequest, marshalRegionalApiDisableAlertRulesRequest, marshalRegionalApiTriggerTestAlertRequest } from "./marshalling.gen.js";
|
|
7
7
|
const jsonContentHeaders = {
|
|
8
8
|
"Content-Type": "application/json; charset=utf-8"
|
|
9
9
|
};
|
|
@@ -187,7 +187,7 @@ class GlobalAPI extends API$1 {
|
|
|
187
187
|
);
|
|
188
188
|
/**
|
|
189
189
|
* List plan types. Retrieve a list of available pricing plan types.
|
|
190
|
-
Deprecated
|
|
190
|
+
Deprecated: retention is now managed at the data source level.
|
|
191
191
|
*
|
|
192
192
|
* @deprecated
|
|
193
193
|
* @param request - The request {@link GlobalApiListPlansRequest}
|
|
@@ -196,7 +196,7 @@ class GlobalAPI extends API$1 {
|
|
|
196
196
|
listPlans = (request = {}) => enrichForPagination("plans", this.pageOfListPlans, request);
|
|
197
197
|
/**
|
|
198
198
|
* Apply a pricing plan. Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
|
|
199
|
-
Deprecated
|
|
199
|
+
Deprecated: retention is now managed at the data source level.
|
|
200
200
|
*
|
|
201
201
|
* @deprecated
|
|
202
202
|
* @param request - The request {@link GlobalApiSelectPlanRequest}
|
|
@@ -215,7 +215,7 @@ class GlobalAPI extends API$1 {
|
|
|
215
215
|
);
|
|
216
216
|
/**
|
|
217
217
|
* Get current plan. Retrieve a pricing plan for the given Project, specified by the ID of the Project.
|
|
218
|
-
Deprecated
|
|
218
|
+
Deprecated: retention is now managed at the data source level.
|
|
219
219
|
*
|
|
220
220
|
* @deprecated
|
|
221
221
|
* @param request - The request {@link GlobalApiGetCurrentPlanRequest}
|
|
@@ -633,6 +633,38 @@ class RegionalAPI extends API$1 {
|
|
|
633
633
|
},
|
|
634
634
|
unmarshalAlertManager
|
|
635
635
|
);
|
|
636
|
+
/**
|
|
637
|
+
* Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.. Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.
|
|
638
|
+
*
|
|
639
|
+
* @param request - The request {@link RegionalApiEnableAlertRulesRequest}
|
|
640
|
+
*/
|
|
641
|
+
enableAlertRules = (request = {}) => this.client.fetch({
|
|
642
|
+
body: JSON.stringify(
|
|
643
|
+
marshalRegionalApiEnableAlertRulesRequest(
|
|
644
|
+
request,
|
|
645
|
+
this.client.settings
|
|
646
|
+
)
|
|
647
|
+
),
|
|
648
|
+
headers: jsonContentHeaders,
|
|
649
|
+
method: "POST",
|
|
650
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/enable-alert-rules`
|
|
651
|
+
});
|
|
652
|
+
/**
|
|
653
|
+
* Disable preconfigured alert rules. Disable alert rules from the list of available preconfigured rules.. Disable preconfigured alert rules. Disable alert rules from the list of available preconfigured rules.
|
|
654
|
+
*
|
|
655
|
+
* @param request - The request {@link RegionalApiDisableAlertRulesRequest}
|
|
656
|
+
*/
|
|
657
|
+
disableAlertRules = (request = {}) => this.client.fetch({
|
|
658
|
+
body: JSON.stringify(
|
|
659
|
+
marshalRegionalApiDisableAlertRulesRequest(
|
|
660
|
+
request,
|
|
661
|
+
this.client.settings
|
|
662
|
+
)
|
|
663
|
+
),
|
|
664
|
+
headers: jsonContentHeaders,
|
|
665
|
+
method: "POST",
|
|
666
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/disable-alert-rules`
|
|
667
|
+
});
|
|
636
668
|
/**
|
|
637
669
|
* Trigger a test alert. Send a test alert to the Alert manager to make sure your contact points get notified.
|
|
638
670
|
*
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export { GlobalAPI, RegionalAPI, } from './api.gen.js';
|
|
2
|
-
export type { Alert, AlertManager, AlertState, ContactPoint, ContactPointEmail, DataSource, DataSourceOrigin, DataSourceType, GetConfigResponse, GetConfigResponseRetention, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, GrafanaUserRole, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesRequestOrderBy, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersRequestOrderBy, ListGrafanaUsersResponse, ListPlansRequestOrderBy, ListPlansResponse, ListTokensRequestOrderBy, ListTokensResponse, Plan, PlanName, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, TokenScope, Usage, UsageOverview, UsageUnit, } from './types.gen';
|
|
2
|
+
export type { Alert, AlertManager, AlertState, ContactPoint, ContactPointEmail, DataSource, DataSourceOrigin, DataSourceType, GetConfigResponse, GetConfigResponseRetention, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, GrafanaUserRole, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesRequestOrderBy, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersRequestOrderBy, ListGrafanaUsersResponse, ListPlansRequestOrderBy, ListPlansResponse, ListTokensRequestOrderBy, ListTokensResponse, Plan, PlanName, PreconfiguredAlertData, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, TokenScope, Usage, UsageOverview, UsageUnit, } from './types.gen';
|
|
3
3
|
export * as ValidationRules from './validation-rules.gen.js';
|
|
@@ -156,6 +156,18 @@ const unmarshalGrafana = (data) => {
|
|
|
156
156
|
grafanaUrl: data.grafana_url
|
|
157
157
|
};
|
|
158
158
|
};
|
|
159
|
+
const unmarshalPreconfiguredAlertData = (data) => {
|
|
160
|
+
if (!json.isJSONObject(data)) {
|
|
161
|
+
throw new TypeError(
|
|
162
|
+
`Unmarshalling the type 'PreconfiguredAlertData' failed as data isn't a dictionary.`
|
|
163
|
+
);
|
|
164
|
+
}
|
|
165
|
+
return {
|
|
166
|
+
displayDescription: data.display_description,
|
|
167
|
+
displayName: data.display_name,
|
|
168
|
+
preconfiguredRuleId: data.preconfigured_rule_id
|
|
169
|
+
};
|
|
170
|
+
};
|
|
159
171
|
const unmarshalAlert = (data) => {
|
|
160
172
|
if (!json.isJSONObject(data)) {
|
|
161
173
|
throw new TypeError(
|
|
@@ -168,6 +180,7 @@ const unmarshalAlert = (data) => {
|
|
|
168
180
|
enabled: data.enabled,
|
|
169
181
|
name: data.name,
|
|
170
182
|
preconfigured: data.preconfigured,
|
|
183
|
+
preconfiguredData: data.preconfigured_data ? unmarshalPreconfiguredAlertData(data.preconfigured_data) : void 0,
|
|
171
184
|
region: data.region,
|
|
172
185
|
rule: data.rule,
|
|
173
186
|
state: data.state ? data.state : void 0
|
|
@@ -343,12 +356,20 @@ const marshalRegionalApiDeleteContactPointRequest = (request, defaults) => ({
|
|
|
343
356
|
const marshalRegionalApiDisableAlertManagerRequest = (request, defaults) => ({
|
|
344
357
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
345
358
|
});
|
|
359
|
+
const marshalRegionalApiDisableAlertRulesRequest = (request, defaults) => ({
|
|
360
|
+
project_id: request.projectId ?? defaults.defaultProjectId,
|
|
361
|
+
rule_ids: request.ruleIds
|
|
362
|
+
});
|
|
346
363
|
const marshalRegionalApiDisableManagedAlertsRequest = (request, defaults) => ({
|
|
347
364
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
348
365
|
});
|
|
349
366
|
const marshalRegionalApiEnableAlertManagerRequest = (request, defaults) => ({
|
|
350
367
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
351
368
|
});
|
|
369
|
+
const marshalRegionalApiEnableAlertRulesRequest = (request, defaults) => ({
|
|
370
|
+
project_id: request.projectId ?? defaults.defaultProjectId,
|
|
371
|
+
rule_ids: request.ruleIds
|
|
372
|
+
});
|
|
352
373
|
const marshalRegionalApiEnableManagedAlertsRequest = (request, defaults) => ({
|
|
353
374
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
354
375
|
});
|
|
@@ -378,8 +399,10 @@ exports.marshalRegionalApiCreateDataSourceRequest = marshalRegionalApiCreateData
|
|
|
378
399
|
exports.marshalRegionalApiCreateTokenRequest = marshalRegionalApiCreateTokenRequest;
|
|
379
400
|
exports.marshalRegionalApiDeleteContactPointRequest = marshalRegionalApiDeleteContactPointRequest;
|
|
380
401
|
exports.marshalRegionalApiDisableAlertManagerRequest = marshalRegionalApiDisableAlertManagerRequest;
|
|
402
|
+
exports.marshalRegionalApiDisableAlertRulesRequest = marshalRegionalApiDisableAlertRulesRequest;
|
|
381
403
|
exports.marshalRegionalApiDisableManagedAlertsRequest = marshalRegionalApiDisableManagedAlertsRequest;
|
|
382
404
|
exports.marshalRegionalApiEnableAlertManagerRequest = marshalRegionalApiEnableAlertManagerRequest;
|
|
405
|
+
exports.marshalRegionalApiEnableAlertRulesRequest = marshalRegionalApiEnableAlertRulesRequest;
|
|
383
406
|
exports.marshalRegionalApiEnableManagedAlertsRequest = marshalRegionalApiEnableManagedAlertsRequest;
|
|
384
407
|
exports.marshalRegionalApiTriggerTestAlertRequest = marshalRegionalApiTriggerTestAlertRequest;
|
|
385
408
|
exports.marshalRegionalApiUpdateContactPointRequest = marshalRegionalApiUpdateContactPointRequest;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DefaultValues } from '@scaleway/sdk-client';
|
|
2
|
-
import type { AlertManager, ContactPoint, DataSource, GetConfigResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
|
|
2
|
+
import type { AlertManager, ContactPoint, DataSource, GetConfigResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
|
|
3
3
|
export declare const unmarshalContactPoint: (data: unknown) => ContactPoint;
|
|
4
4
|
export declare const unmarshalDataSource: (data: unknown) => DataSource;
|
|
5
5
|
export declare const unmarshalGrafanaProductDashboard: (data: unknown) => GrafanaProductDashboard;
|
|
@@ -26,8 +26,10 @@ export declare const marshalRegionalApiCreateDataSourceRequest: (request: Region
|
|
|
26
26
|
export declare const marshalRegionalApiCreateTokenRequest: (request: RegionalApiCreateTokenRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
27
27
|
export declare const marshalRegionalApiDeleteContactPointRequest: (request: RegionalApiDeleteContactPointRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
28
28
|
export declare const marshalRegionalApiDisableAlertManagerRequest: (request: RegionalApiDisableAlertManagerRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
29
|
+
export declare const marshalRegionalApiDisableAlertRulesRequest: (request: RegionalApiDisableAlertRulesRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
29
30
|
export declare const marshalRegionalApiDisableManagedAlertsRequest: (request: RegionalApiDisableManagedAlertsRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
30
31
|
export declare const marshalRegionalApiEnableAlertManagerRequest: (request: RegionalApiEnableAlertManagerRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
32
|
+
export declare const marshalRegionalApiEnableAlertRulesRequest: (request: RegionalApiEnableAlertRulesRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
31
33
|
export declare const marshalRegionalApiEnableManagedAlertsRequest: (request: RegionalApiEnableManagedAlertsRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
32
34
|
export declare const marshalRegionalApiTriggerTestAlertRequest: (request: RegionalApiTriggerTestAlertRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
33
35
|
export declare const marshalRegionalApiUpdateContactPointRequest: (request: RegionalApiUpdateContactPointRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
@@ -154,6 +154,18 @@ const unmarshalGrafana = (data) => {
|
|
|
154
154
|
grafanaUrl: data.grafana_url
|
|
155
155
|
};
|
|
156
156
|
};
|
|
157
|
+
const unmarshalPreconfiguredAlertData = (data) => {
|
|
158
|
+
if (!isJSONObject(data)) {
|
|
159
|
+
throw new TypeError(
|
|
160
|
+
`Unmarshalling the type 'PreconfiguredAlertData' failed as data isn't a dictionary.`
|
|
161
|
+
);
|
|
162
|
+
}
|
|
163
|
+
return {
|
|
164
|
+
displayDescription: data.display_description,
|
|
165
|
+
displayName: data.display_name,
|
|
166
|
+
preconfiguredRuleId: data.preconfigured_rule_id
|
|
167
|
+
};
|
|
168
|
+
};
|
|
157
169
|
const unmarshalAlert = (data) => {
|
|
158
170
|
if (!isJSONObject(data)) {
|
|
159
171
|
throw new TypeError(
|
|
@@ -166,6 +178,7 @@ const unmarshalAlert = (data) => {
|
|
|
166
178
|
enabled: data.enabled,
|
|
167
179
|
name: data.name,
|
|
168
180
|
preconfigured: data.preconfigured,
|
|
181
|
+
preconfiguredData: data.preconfigured_data ? unmarshalPreconfiguredAlertData(data.preconfigured_data) : void 0,
|
|
169
182
|
region: data.region,
|
|
170
183
|
rule: data.rule,
|
|
171
184
|
state: data.state ? data.state : void 0
|
|
@@ -341,12 +354,20 @@ const marshalRegionalApiDeleteContactPointRequest = (request, defaults) => ({
|
|
|
341
354
|
const marshalRegionalApiDisableAlertManagerRequest = (request, defaults) => ({
|
|
342
355
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
343
356
|
});
|
|
357
|
+
const marshalRegionalApiDisableAlertRulesRequest = (request, defaults) => ({
|
|
358
|
+
project_id: request.projectId ?? defaults.defaultProjectId,
|
|
359
|
+
rule_ids: request.ruleIds
|
|
360
|
+
});
|
|
344
361
|
const marshalRegionalApiDisableManagedAlertsRequest = (request, defaults) => ({
|
|
345
362
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
346
363
|
});
|
|
347
364
|
const marshalRegionalApiEnableAlertManagerRequest = (request, defaults) => ({
|
|
348
365
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
349
366
|
});
|
|
367
|
+
const marshalRegionalApiEnableAlertRulesRequest = (request, defaults) => ({
|
|
368
|
+
project_id: request.projectId ?? defaults.defaultProjectId,
|
|
369
|
+
rule_ids: request.ruleIds
|
|
370
|
+
});
|
|
350
371
|
const marshalRegionalApiEnableManagedAlertsRequest = (request, defaults) => ({
|
|
351
372
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
352
373
|
});
|
|
@@ -377,8 +398,10 @@ export {
|
|
|
377
398
|
marshalRegionalApiCreateTokenRequest,
|
|
378
399
|
marshalRegionalApiDeleteContactPointRequest,
|
|
379
400
|
marshalRegionalApiDisableAlertManagerRequest,
|
|
401
|
+
marshalRegionalApiDisableAlertRulesRequest,
|
|
380
402
|
marshalRegionalApiDisableManagedAlertsRequest,
|
|
381
403
|
marshalRegionalApiEnableAlertManagerRequest,
|
|
404
|
+
marshalRegionalApiEnableAlertRulesRequest,
|
|
382
405
|
marshalRegionalApiEnableManagedAlertsRequest,
|
|
383
406
|
marshalRegionalApiTriggerTestAlertRequest,
|
|
384
407
|
marshalRegionalApiUpdateContactPointRequest,
|
|
@@ -10,6 +10,23 @@ export type ListTokensRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'n
|
|
|
10
10
|
export type PlanName = 'unknown_name' | 'free' | 'premium' | 'custom';
|
|
11
11
|
export type TokenScope = 'unknown_scope' | 'read_only_metrics' | 'write_only_metrics' | 'full_access_metrics_rules' | 'read_only_logs' | 'write_only_logs' | 'full_access_logs_rules' | 'full_access_alert_manager' | 'read_only_traces' | 'write_only_traces';
|
|
12
12
|
export type UsageUnit = 'unknown_unit' | 'bytes' | 'samples';
|
|
13
|
+
/**
|
|
14
|
+
* Structure for additional data relative to preconfigured alerts.
|
|
15
|
+
*/
|
|
16
|
+
export interface PreconfiguredAlertData {
|
|
17
|
+
/**
|
|
18
|
+
* ID of the preconfigured rule if the alert is preconfigured.
|
|
19
|
+
*/
|
|
20
|
+
preconfiguredRuleId: string;
|
|
21
|
+
/**
|
|
22
|
+
* Human readable name of the alert.
|
|
23
|
+
*/
|
|
24
|
+
displayName: string;
|
|
25
|
+
/**
|
|
26
|
+
* Human readable description of the alert.
|
|
27
|
+
*/
|
|
28
|
+
displayDescription: string;
|
|
29
|
+
}
|
|
13
30
|
export interface ContactPointEmail {
|
|
14
31
|
to: string;
|
|
15
32
|
}
|
|
@@ -18,18 +35,46 @@ export interface GetConfigResponseRetention {
|
|
|
18
35
|
maxDays: number;
|
|
19
36
|
defaultDays: number;
|
|
20
37
|
}
|
|
38
|
+
/**
|
|
39
|
+
* Structure representing an alert.
|
|
40
|
+
*/
|
|
21
41
|
export interface Alert {
|
|
22
42
|
/**
|
|
23
|
-
*
|
|
43
|
+
* The region in which the alert is defined.
|
|
24
44
|
*/
|
|
25
45
|
region: ScwRegion;
|
|
46
|
+
/**
|
|
47
|
+
* Indicates if the alert is preconfigured or custom.
|
|
48
|
+
*/
|
|
26
49
|
preconfigured: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Name of the alert.
|
|
52
|
+
*/
|
|
27
53
|
name: string;
|
|
54
|
+
/**
|
|
55
|
+
* Rule defining the alert condition.
|
|
56
|
+
*/
|
|
28
57
|
rule: string;
|
|
58
|
+
/**
|
|
59
|
+
* Duration for which the alert must be active before firing. The format of this duration follows the prometheus duration format.
|
|
60
|
+
*/
|
|
29
61
|
duration: string;
|
|
62
|
+
/**
|
|
63
|
+
* Indicates if the alert is enabled or disabled. Only preconfigured alerts can be disabled.
|
|
64
|
+
*/
|
|
30
65
|
enabled: boolean;
|
|
66
|
+
/**
|
|
67
|
+
* Current state of the alert. Possible states are `inactive`, `pending`, and `firing`.
|
|
68
|
+
*/
|
|
31
69
|
state?: AlertState;
|
|
70
|
+
/**
|
|
71
|
+
* Annotations for the alert, used to provide additional information about the alert.
|
|
72
|
+
*/
|
|
32
73
|
annotations: Record<string, string>;
|
|
74
|
+
/**
|
|
75
|
+
* Contains additional data for preconfigured alerts, such as the rule ID, display name, and description. Only present if the alert is preconfigured.
|
|
76
|
+
*/
|
|
77
|
+
preconfiguredData?: PreconfiguredAlertData;
|
|
33
78
|
}
|
|
34
79
|
/**
|
|
35
80
|
* Contact point.
|
|
@@ -689,6 +734,14 @@ export type RegionalApiDisableAlertManagerRequest = {
|
|
|
689
734
|
*/
|
|
690
735
|
projectId?: string;
|
|
691
736
|
};
|
|
737
|
+
export type RegionalApiDisableAlertRulesRequest = {
|
|
738
|
+
/**
|
|
739
|
+
* Region to target. If none is passed will use default region from the config.
|
|
740
|
+
*/
|
|
741
|
+
region?: ScwRegion;
|
|
742
|
+
projectId?: string;
|
|
743
|
+
ruleIds?: string[];
|
|
744
|
+
};
|
|
692
745
|
/**
|
|
693
746
|
* Disable the sending of managed alerts.
|
|
694
747
|
*/
|
|
@@ -715,6 +768,14 @@ export type RegionalApiEnableAlertManagerRequest = {
|
|
|
715
768
|
*/
|
|
716
769
|
projectId?: string;
|
|
717
770
|
};
|
|
771
|
+
export type RegionalApiEnableAlertRulesRequest = {
|
|
772
|
+
/**
|
|
773
|
+
* Region to target. If none is passed will use default region from the config.
|
|
774
|
+
*/
|
|
775
|
+
region?: ScwRegion;
|
|
776
|
+
projectId?: string;
|
|
777
|
+
ruleIds?: string[];
|
|
778
|
+
};
|
|
718
779
|
/**
|
|
719
780
|
* Enable the sending of managed alerts.
|
|
720
781
|
*/
|
|
@@ -805,7 +866,7 @@ export type RegionalApiListAlertsRequest = {
|
|
|
805
866
|
*/
|
|
806
867
|
isPreconfigured?: boolean;
|
|
807
868
|
/**
|
|
808
|
-
* Valid values to filter on are `
|
|
869
|
+
* Valid values to filter on are `inactive`, `pending` and `firing`. If omitted, no filtering is applied on alert states. Other filters may still apply.
|
|
809
870
|
*/
|
|
810
871
|
state?: AlertState;
|
|
811
872
|
};
|
|
@@ -85,7 +85,7 @@ export interface OfferSANInfo {
|
|
|
85
85
|
*/
|
|
86
86
|
size: number;
|
|
87
87
|
/**
|
|
88
|
-
* High
|
|
88
|
+
* High availability offer.
|
|
89
89
|
*/
|
|
90
90
|
ha: boolean;
|
|
91
91
|
/**
|
|
@@ -321,11 +321,11 @@ export interface OS {
|
|
|
321
321
|
*/
|
|
322
322
|
panelPasswordRegex?: string;
|
|
323
323
|
/**
|
|
324
|
-
* If both requires_valid_hostname & hostname_regex are set, it means that at least one of the
|
|
324
|
+
* If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
|
|
325
325
|
*/
|
|
326
326
|
requiresValidHostname?: boolean;
|
|
327
327
|
/**
|
|
328
|
-
* If both requires_valid_hostname & hostname_regex are set, it means that at least one of the
|
|
328
|
+
* If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
|
|
329
329
|
*/
|
|
330
330
|
hostnameRegex?: string;
|
|
331
331
|
/**
|
|
@@ -482,6 +482,28 @@ class API extends api.API {
|
|
|
482
482
|
method: "DELETE",
|
|
483
483
|
path: `/edge-services/v1beta1/backend-stages/${marshalling.validatePathParam("backendStageId", request.backendStageId)}`
|
|
484
484
|
});
|
|
485
|
+
searchBackendStages = (request = {}) => this.client.fetch(
|
|
486
|
+
{
|
|
487
|
+
method: "GET",
|
|
488
|
+
path: `/edge-services/v1beta1/search-backend-stages`,
|
|
489
|
+
urlParams: marshalling.urlParams(
|
|
490
|
+
["bucket_name", request.bucketName],
|
|
491
|
+
["bucket_region", request.bucketRegion],
|
|
492
|
+
["lb_id", request.lbId],
|
|
493
|
+
["order_by", request.orderBy],
|
|
494
|
+
["page", request.page],
|
|
495
|
+
[
|
|
496
|
+
"page_size",
|
|
497
|
+
request.pageSize ?? this.client.settings.defaultPageSize
|
|
498
|
+
],
|
|
499
|
+
[
|
|
500
|
+
"project_id",
|
|
501
|
+
request.projectId ?? this.client.settings.defaultProjectId
|
|
502
|
+
]
|
|
503
|
+
)
|
|
504
|
+
},
|
|
505
|
+
marshalling_gen.unmarshalListBackendStagesResponse
|
|
506
|
+
);
|
|
485
507
|
pageOfListWafStages = (request) => this.client.fetch(
|
|
486
508
|
{
|
|
487
509
|
method: "GET",
|
|
@@ -560,6 +582,25 @@ class API extends api.API {
|
|
|
560
582
|
method: "DELETE",
|
|
561
583
|
path: `/edge-services/v1beta1/waf-stages/${marshalling.validatePathParam("wafStageId", request.wafStageId)}`
|
|
562
584
|
});
|
|
585
|
+
searchWafStages = (request = {}) => this.client.fetch(
|
|
586
|
+
{
|
|
587
|
+
method: "GET",
|
|
588
|
+
path: `/edge-services/v1beta1/search-waf-stages`,
|
|
589
|
+
urlParams: marshalling.urlParams(
|
|
590
|
+
["order_by", request.orderBy],
|
|
591
|
+
["page", request.page],
|
|
592
|
+
[
|
|
593
|
+
"page_size",
|
|
594
|
+
request.pageSize ?? this.client.settings.defaultPageSize
|
|
595
|
+
],
|
|
596
|
+
[
|
|
597
|
+
"project_id",
|
|
598
|
+
request.projectId ?? this.client.settings.defaultProjectId
|
|
599
|
+
]
|
|
600
|
+
)
|
|
601
|
+
},
|
|
602
|
+
marshalling_gen.unmarshalListWafStagesResponse
|
|
603
|
+
);
|
|
563
604
|
pageOfListRouteStages = (request) => this.client.fetch(
|
|
564
605
|
{
|
|
565
606
|
method: "GET",
|
|
@@ -707,28 +748,6 @@ class API extends api.API {
|
|
|
707
748
|
},
|
|
708
749
|
marshalling_gen.unmarshalCheckPEMChainResponse
|
|
709
750
|
);
|
|
710
|
-
searchBackendStages = (request = {}) => this.client.fetch(
|
|
711
|
-
{
|
|
712
|
-
method: "GET",
|
|
713
|
-
path: `/edge-services/v1beta1/search-backend-stages`,
|
|
714
|
-
urlParams: marshalling.urlParams(
|
|
715
|
-
["bucket_name", request.bucketName],
|
|
716
|
-
["bucket_region", request.bucketRegion],
|
|
717
|
-
["lb_id", request.lbId],
|
|
718
|
-
["order_by", request.orderBy],
|
|
719
|
-
["page", request.page],
|
|
720
|
-
[
|
|
721
|
-
"page_size",
|
|
722
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
723
|
-
],
|
|
724
|
-
[
|
|
725
|
-
"project_id",
|
|
726
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
727
|
-
]
|
|
728
|
-
)
|
|
729
|
-
},
|
|
730
|
-
marshalling_gen.unmarshalListBackendStagesResponse
|
|
731
|
-
);
|
|
732
751
|
pageOfListPurgeRequests = (request = {}) => this.client.fetch(
|
|
733
752
|
{
|
|
734
753
|
method: "GET",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { API as ParentAPI } from '@scaleway/sdk-client';
|
|
2
2
|
import type { WaitForOptions } from '@scaleway/sdk-client';
|
|
3
|
-
import type { AddRouteRulesRequest, AddRouteRulesResponse, BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateRouteStageRequest, CreateTLSStageRequest, CreateWafStageRequest, DNSStage, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteCurrentPlanRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteRouteStageRequest, DeleteTLSStageRequest, DeleteWafStageRequest, GetBackendStageRequest, GetBillingRequest, GetBillingResponse, GetCacheStageRequest, GetCurrentPlanRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetRouteStageRequest, GetTLSStageRequest, GetWafStageRequest, HeadStageResponse, ListBackendStagesRequest, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesResponse, ListHeadStagesRequest, ListHeadStagesResponse, ListPipelinesRequest, ListPipelinesResponse, ListPipelinesWithStagesRequest, ListPipelinesWithStagesResponse, ListPlansResponse, ListPurgeRequestsRequest, ListPurgeRequestsResponse, ListRouteRulesRequest, ListRouteRulesResponse, ListRouteStagesRequest, ListRouteStagesResponse, ListTLSStagesRequest, ListTLSStagesResponse, ListWafStagesRequest, ListWafStagesResponse, Pipeline, Plan, PurgeRequest, RouteStage, SearchBackendStagesRequest, SelectPlanRequest, SetHeadStageRequest, SetRouteRulesRequest, SetRouteRulesResponse, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateRouteStageRequest, UpdateTLSStageRequest, UpdateWafStageRequest, WafStage } from './types.gen';
|
|
3
|
+
import type { AddRouteRulesRequest, AddRouteRulesResponse, BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateRouteStageRequest, CreateTLSStageRequest, CreateWafStageRequest, DNSStage, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteCurrentPlanRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteRouteStageRequest, DeleteTLSStageRequest, DeleteWafStageRequest, GetBackendStageRequest, GetBillingRequest, GetBillingResponse, GetCacheStageRequest, GetCurrentPlanRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetRouteStageRequest, GetTLSStageRequest, GetWafStageRequest, HeadStageResponse, ListBackendStagesRequest, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesResponse, ListHeadStagesRequest, ListHeadStagesResponse, ListPipelinesRequest, ListPipelinesResponse, ListPipelinesWithStagesRequest, ListPipelinesWithStagesResponse, ListPlansResponse, ListPurgeRequestsRequest, ListPurgeRequestsResponse, ListRouteRulesRequest, ListRouteRulesResponse, ListRouteStagesRequest, ListRouteStagesResponse, ListTLSStagesRequest, ListTLSStagesResponse, ListWafStagesRequest, ListWafStagesResponse, Pipeline, Plan, PurgeRequest, RouteStage, SearchBackendStagesRequest, SearchWafStagesRequest, SelectPlanRequest, SetHeadStageRequest, SetRouteRulesRequest, SetRouteRulesResponse, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateRouteStageRequest, UpdateTLSStageRequest, UpdateWafStageRequest, WafStage } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Edge Services API.
|
|
6
6
|
*/
|
|
@@ -220,6 +220,7 @@ export declare class API extends ParentAPI {
|
|
|
220
220
|
* @param request - The request {@link DeleteBackendStageRequest}
|
|
221
221
|
*/
|
|
222
222
|
deleteBackendStage: (request: Readonly<DeleteBackendStageRequest>) => Promise<void>;
|
|
223
|
+
searchBackendStages: (request?: Readonly<SearchBackendStagesRequest>) => Promise<ListBackendStagesResponse>;
|
|
223
224
|
protected pageOfListWafStages: (request: Readonly<ListWafStagesRequest>) => Promise<ListWafStagesResponse>;
|
|
224
225
|
/**
|
|
225
226
|
* List WAF stages. List all WAF stages, for a Scaleway Organization or Scaleway Project. By default, the WAF stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
|
|
@@ -258,6 +259,7 @@ export declare class API extends ParentAPI {
|
|
|
258
259
|
* @param request - The request {@link DeleteWafStageRequest}
|
|
259
260
|
*/
|
|
260
261
|
deleteWafStage: (request: Readonly<DeleteWafStageRequest>) => Promise<void>;
|
|
262
|
+
searchWafStages: (request?: Readonly<SearchWafStagesRequest>) => Promise<ListWafStagesResponse>;
|
|
261
263
|
protected pageOfListRouteStages: (request: Readonly<ListRouteStagesRequest>) => Promise<ListRouteStagesResponse>;
|
|
262
264
|
/**
|
|
263
265
|
* List route stages. List all route stages, for a given pipeline. By default, the route stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
|
|
@@ -319,7 +321,6 @@ export declare class API extends ParentAPI {
|
|
|
319
321
|
addRouteRules: (request: Readonly<AddRouteRulesRequest>) => Promise<AddRouteRulesResponse>;
|
|
320
322
|
checkDomain: (request: Readonly<CheckDomainRequest>) => Promise<CheckDomainResponse>;
|
|
321
323
|
checkPEMChain: (request: Readonly<CheckPEMChainRequest>) => Promise<CheckPEMChainResponse>;
|
|
322
|
-
searchBackendStages: (request?: Readonly<SearchBackendStagesRequest>) => Promise<ListBackendStagesResponse>;
|
|
323
324
|
protected pageOfListPurgeRequests: (request?: Readonly<ListPurgeRequestsRequest>) => Promise<ListPurgeRequestsResponse>;
|
|
324
325
|
/**
|
|
325
326
|
* List purge requests. List all purge requests, for a Scaleway Organization or Scaleway Project. This enables you to retrieve a history of all previously-made purge requests. By default, the purge requests returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
|