@scaleway/sdk 2.36.0 → 2.38.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/cockpit/v1/api.gen.cjs +21 -0
- package/dist/api/cockpit/v1/api.gen.d.ts +9 -1
- package/dist/api/cockpit/v1/api.gen.js +22 -1
- package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
- package/dist/api/cockpit/v1/marshalling.gen.cjs +4 -0
- package/dist/api/cockpit/v1/marshalling.gen.d.ts +2 -1
- package/dist/api/cockpit/v1/marshalling.gen.js +4 -0
- package/dist/api/cockpit/v1/types.gen.d.ts +12 -0
- package/dist/api/cockpit/v1/validation-rules.gen.cjs +8 -0
- package/dist/api/cockpit/v1/validation-rules.gen.d.ts +7 -0
- package/dist/api/cockpit/v1/validation-rules.gen.js +9 -1
- package/dist/api/edge_services/index.d.ts +1 -0
- package/dist/api/edge_services/v1alpha1/api.gen.d.ts +300 -0
- package/dist/api/edge_services/v1alpha1/content.gen.d.ts +5 -0
- package/dist/api/edge_services/v1alpha1/index.gen.d.ts +3 -0
- package/dist/api/edge_services/v1alpha1/marshalling.gen.d.ts +31 -0
- package/dist/api/edge_services/v1alpha1/types.gen.d.ts +692 -0
- package/dist/api/inference/v1beta1/types.gen.d.ts +1 -1
- package/dist/api/instance/v1/marshalling.gen.cjs +2 -2
- package/dist/api/instance/v1/marshalling.gen.js +2 -2
- package/dist/api/instance/v1/types.gen.d.ts +2 -1
- package/dist/api/ipam/v1/api.gen.cjs +1 -0
- package/dist/api/ipam/v1/api.gen.js +1 -0
- package/dist/api/ipam/v1/types.gen.d.ts +5 -0
- package/dist/api/lb/v1/marshalling.gen.cjs +2 -0
- package/dist/api/lb/v1/marshalling.gen.js +2 -0
- package/dist/api/lb/v1/types.gen.d.ts +16 -0
- package/dist/api/marketplace/v2/types.gen.d.ts +19 -6
- package/dist/api/secret/v1beta1/marshalling.gen.cjs +1 -0
- package/dist/api/secret/v1beta1/marshalling.gen.js +1 -0
- package/dist/api/secret/v1beta1/types.gen.d.ts +1 -0
- package/dist/api/vpc/v2/api.gen.cjs +57 -0
- package/dist/api/vpc/v2/api.gen.d.ts +29 -1
- package/dist/api/vpc/v2/api.gen.js +58 -1
- package/dist/api/vpc/v2/index.gen.cjs +2 -0
- package/dist/api/vpc/v2/index.gen.d.ts +2 -1
- package/dist/api/vpc/v2/index.gen.js +3 -1
- package/dist/api/vpc/v2/marshalling.gen.cjs +37 -0
- package/dist/api/vpc/v2/marshalling.gen.d.ts +4 -1
- package/dist/api/vpc/v2/marshalling.gen.js +37 -0
- package/dist/api/vpc/v2/types.gen.d.ts +78 -0
- package/dist/api/vpc/v2/validation-rules.gen.cjs +8 -0
- package/dist/api/vpc/v2/validation-rules.gen.d.ts +5 -0
- package/dist/api/vpc/v2/validation-rules.gen.js +8 -0
- package/dist/api/webhosting/v1alpha1/marshalling.gen.cjs +1 -0
- package/dist/api/webhosting/v1alpha1/marshalling.gen.js +1 -0
- package/dist/api/webhosting/v1alpha1/types.gen.d.ts +2 -0
- package/dist/bridge.d.ts +2 -1
- package/dist/scw/constants.cjs +1 -1
- package/dist/scw/constants.d.ts +2 -2
- package/dist/scw/constants.js +1 -1
- package/dist/scw/custom-marshalling.d.ts +13 -0
- package/dist/scw/custom-types.d.ts +8 -0
- package/package.json +2 -2
|
@@ -335,6 +335,27 @@ class RegionalAPI extends api.API {
|
|
|
335
335
|
* @returns A Promise of ListDataSourcesResponse
|
|
336
336
|
*/
|
|
337
337
|
listDataSources = (request = {}) => resourcePaginator.enrichForPagination("dataSources", this.pageOfListDataSources, request);
|
|
338
|
+
/**
|
|
339
|
+
* Update a data source. Update a given data source name, specified by the
|
|
340
|
+
* data source ID.
|
|
341
|
+
*
|
|
342
|
+
* @param request - The request {@link RegionalApiUpdateDataSourceRequest}
|
|
343
|
+
* @returns A Promise of DataSource
|
|
344
|
+
*/
|
|
345
|
+
updateDataSource = (request) => this.client.fetch(
|
|
346
|
+
{
|
|
347
|
+
body: JSON.stringify(
|
|
348
|
+
marshalling_gen.marshalRegionalApiUpdateDataSourceRequest(
|
|
349
|
+
request,
|
|
350
|
+
this.client.settings
|
|
351
|
+
)
|
|
352
|
+
),
|
|
353
|
+
headers: jsonContentHeaders,
|
|
354
|
+
method: "PATCH",
|
|
355
|
+
path: `/cockpit/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/data-sources/${marshalling.validatePathParam("dataSourceId", request.dataSourceId)}`
|
|
356
|
+
},
|
|
357
|
+
marshalling_gen.unmarshalDataSource
|
|
358
|
+
);
|
|
338
359
|
/**
|
|
339
360
|
* Get data source usage overview. Retrieve the data source usage overview per
|
|
340
361
|
* type for the specified Project.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { API as ParentAPI } from '../../../bridge';
|
|
2
2
|
import type { Region } from '../../../bridge';
|
|
3
|
-
import type { AlertManager, ContactPoint, DataSource, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListManagedAlertsResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListManagedAlertsRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, Token, UsageOverview } from './types.gen';
|
|
3
|
+
import type { AlertManager, ContactPoint, DataSource, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListManagedAlertsResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListManagedAlertsRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Cockpit Global API.
|
|
6
6
|
*
|
|
@@ -175,6 +175,14 @@ export declare class RegionalAPI extends ParentAPI {
|
|
|
175
175
|
all: () => Promise<DataSource[]>;
|
|
176
176
|
[Symbol.asyncIterator]: () => AsyncGenerator<DataSource[], void, void>;
|
|
177
177
|
};
|
|
178
|
+
/**
|
|
179
|
+
* Update a data source. Update a given data source name, specified by the
|
|
180
|
+
* data source ID.
|
|
181
|
+
*
|
|
182
|
+
* @param request - The request {@link RegionalApiUpdateDataSourceRequest}
|
|
183
|
+
* @returns A Promise of DataSource
|
|
184
|
+
*/
|
|
185
|
+
updateDataSource: (request: Readonly<RegionalApiUpdateDataSourceRequest>) => Promise<DataSource>;
|
|
178
186
|
/**
|
|
179
187
|
* Get data source usage overview. Retrieve the data source usage overview per
|
|
180
188
|
* type for the specified Project.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { API as API$1 } from "../../../scw/api.js";
|
|
2
2
|
import { urlParams, validatePathParam } from "../../../helpers/marshalling.js";
|
|
3
3
|
import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
|
|
4
|
-
import { unmarshalGrafana, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalGlobalApiCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalGlobalApiResetGrafanaUserPasswordRequest, unmarshalListGrafanaProductDashboardsResponse, unmarshalGrafanaProductDashboard, unmarshalListPlansResponse, marshalGlobalApiSelectPlanRequest, unmarshalPlan, marshalRegionalApiCreateDataSourceRequest, unmarshalDataSource, unmarshalListDataSourcesResponse, unmarshalUsageOverview, marshalRegionalApiCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, unmarshalAlertManager, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiDisableAlertManagerRequest, marshalRegionalApiCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalRegionalApiDeleteContactPointRequest, unmarshalListManagedAlertsResponse, marshalRegionalApiEnableManagedAlertsRequest, marshalRegionalApiDisableManagedAlertsRequest, marshalRegionalApiTriggerTestAlertRequest } from "./marshalling.gen.js";
|
|
4
|
+
import { unmarshalGrafana, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalGlobalApiCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalGlobalApiResetGrafanaUserPasswordRequest, unmarshalListGrafanaProductDashboardsResponse, unmarshalGrafanaProductDashboard, unmarshalListPlansResponse, marshalGlobalApiSelectPlanRequest, unmarshalPlan, marshalRegionalApiCreateDataSourceRequest, unmarshalDataSource, unmarshalListDataSourcesResponse, marshalRegionalApiUpdateDataSourceRequest, unmarshalUsageOverview, marshalRegionalApiCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, unmarshalAlertManager, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiDisableAlertManagerRequest, marshalRegionalApiCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalRegionalApiDeleteContactPointRequest, unmarshalListManagedAlertsResponse, marshalRegionalApiEnableManagedAlertsRequest, marshalRegionalApiDisableManagedAlertsRequest, marshalRegionalApiTriggerTestAlertRequest } from "./marshalling.gen.js";
|
|
5
5
|
const jsonContentHeaders = {
|
|
6
6
|
"Content-Type": "application/json; charset=utf-8"
|
|
7
7
|
};
|
|
@@ -333,6 +333,27 @@ class RegionalAPI extends API$1 {
|
|
|
333
333
|
* @returns A Promise of ListDataSourcesResponse
|
|
334
334
|
*/
|
|
335
335
|
listDataSources = (request = {}) => enrichForPagination("dataSources", this.pageOfListDataSources, request);
|
|
336
|
+
/**
|
|
337
|
+
* Update a data source. Update a given data source name, specified by the
|
|
338
|
+
* data source ID.
|
|
339
|
+
*
|
|
340
|
+
* @param request - The request {@link RegionalApiUpdateDataSourceRequest}
|
|
341
|
+
* @returns A Promise of DataSource
|
|
342
|
+
*/
|
|
343
|
+
updateDataSource = (request) => this.client.fetch(
|
|
344
|
+
{
|
|
345
|
+
body: JSON.stringify(
|
|
346
|
+
marshalRegionalApiUpdateDataSourceRequest(
|
|
347
|
+
request,
|
|
348
|
+
this.client.settings
|
|
349
|
+
)
|
|
350
|
+
),
|
|
351
|
+
headers: jsonContentHeaders,
|
|
352
|
+
method: "PATCH",
|
|
353
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/data-sources/${validatePathParam("dataSourceId", request.dataSourceId)}`
|
|
354
|
+
},
|
|
355
|
+
unmarshalDataSource
|
|
356
|
+
);
|
|
336
357
|
/**
|
|
337
358
|
* Get data source usage overview. Retrieve the data source usage overview per
|
|
338
359
|
* type for the specified Project.
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export { GlobalAPI, RegionalAPI } from './api.gen';
|
|
2
|
-
export type { Alert, AlertManager, ContactPoint, ContactPointEmail, DataSource, DataSourceOrigin, DataSourceType, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, GrafanaUserRole, ListContactPointsResponse, ListDataSourcesRequestOrderBy, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersRequestOrderBy, ListGrafanaUsersResponse, ListManagedAlertsRequestOrderBy, ListManagedAlertsResponse, ListPlansRequestOrderBy, ListPlansResponse, ListTokensRequestOrderBy, ListTokensResponse, Plan, PlanName, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListManagedAlertsRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, Token, TokenScope, Usage, UsageOverview, UsageUnit, } from './types.gen';
|
|
2
|
+
export type { Alert, AlertManager, ContactPoint, ContactPointEmail, DataSource, DataSourceOrigin, DataSourceType, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, GrafanaUserRole, ListContactPointsResponse, ListDataSourcesRequestOrderBy, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersRequestOrderBy, ListGrafanaUsersResponse, ListManagedAlertsRequestOrderBy, ListManagedAlertsResponse, ListPlansRequestOrderBy, ListPlansResponse, ListTokensRequestOrderBy, ListTokensResponse, Plan, PlanName, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListManagedAlertsRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateDataSourceRequest, Token, TokenScope, Usage, UsageOverview, UsageUnit, } from './types.gen';
|
|
3
3
|
export * as ValidationRules from './validation-rules.gen';
|
|
@@ -320,6 +320,9 @@ const marshalRegionalApiEnableManagedAlertsRequest = (request, defaults) => ({
|
|
|
320
320
|
const marshalRegionalApiTriggerTestAlertRequest = (request, defaults) => ({
|
|
321
321
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
322
322
|
});
|
|
323
|
+
const marshalRegionalApiUpdateDataSourceRequest = (request, defaults) => ({
|
|
324
|
+
name: request.name
|
|
325
|
+
});
|
|
323
326
|
exports.marshalGlobalApiCreateGrafanaUserRequest = marshalGlobalApiCreateGrafanaUserRequest;
|
|
324
327
|
exports.marshalGlobalApiResetGrafanaUserPasswordRequest = marshalGlobalApiResetGrafanaUserPasswordRequest;
|
|
325
328
|
exports.marshalGlobalApiSelectPlanRequest = marshalGlobalApiSelectPlanRequest;
|
|
@@ -333,6 +336,7 @@ exports.marshalRegionalApiDisableManagedAlertsRequest = marshalRegionalApiDisabl
|
|
|
333
336
|
exports.marshalRegionalApiEnableAlertManagerRequest = marshalRegionalApiEnableAlertManagerRequest;
|
|
334
337
|
exports.marshalRegionalApiEnableManagedAlertsRequest = marshalRegionalApiEnableManagedAlertsRequest;
|
|
335
338
|
exports.marshalRegionalApiTriggerTestAlertRequest = marshalRegionalApiTriggerTestAlertRequest;
|
|
339
|
+
exports.marshalRegionalApiUpdateDataSourceRequest = marshalRegionalApiUpdateDataSourceRequest;
|
|
336
340
|
exports.unmarshalAlertManager = unmarshalAlertManager;
|
|
337
341
|
exports.unmarshalContactPoint = unmarshalContactPoint;
|
|
338
342
|
exports.unmarshalDataSource = unmarshalDataSource;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DefaultValues } from '../../../bridge';
|
|
2
|
-
import type { AlertManager, ContactPoint, DataSource, GlobalApiCreateGrafanaUserRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListManagedAlertsResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiTriggerTestAlertRequest, Token, UsageOverview } from './types.gen';
|
|
2
|
+
import type { AlertManager, ContactPoint, DataSource, GlobalApiCreateGrafanaUserRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListManagedAlertsResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiTriggerTestAlertRequest, 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;
|
|
@@ -29,3 +29,4 @@ export declare const marshalRegionalApiDisableManagedAlertsRequest: (request: Re
|
|
|
29
29
|
export declare const marshalRegionalApiEnableAlertManagerRequest: (request: RegionalApiEnableAlertManagerRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
30
30
|
export declare const marshalRegionalApiEnableManagedAlertsRequest: (request: RegionalApiEnableManagedAlertsRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
31
31
|
export declare const marshalRegionalApiTriggerTestAlertRequest: (request: RegionalApiTriggerTestAlertRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
32
|
+
export declare const marshalRegionalApiUpdateDataSourceRequest: (request: RegionalApiUpdateDataSourceRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
@@ -318,6 +318,9 @@ const marshalRegionalApiEnableManagedAlertsRequest = (request, defaults) => ({
|
|
|
318
318
|
const marshalRegionalApiTriggerTestAlertRequest = (request, defaults) => ({
|
|
319
319
|
project_id: request.projectId ?? defaults.defaultProjectId
|
|
320
320
|
});
|
|
321
|
+
const marshalRegionalApiUpdateDataSourceRequest = (request, defaults) => ({
|
|
322
|
+
name: request.name
|
|
323
|
+
});
|
|
321
324
|
export {
|
|
322
325
|
marshalGlobalApiCreateGrafanaUserRequest,
|
|
323
326
|
marshalGlobalApiResetGrafanaUserPasswordRequest,
|
|
@@ -332,6 +335,7 @@ export {
|
|
|
332
335
|
marshalRegionalApiEnableAlertManagerRequest,
|
|
333
336
|
marshalRegionalApiEnableManagedAlertsRequest,
|
|
334
337
|
marshalRegionalApiTriggerTestAlertRequest,
|
|
338
|
+
marshalRegionalApiUpdateDataSourceRequest,
|
|
335
339
|
unmarshalAlertManager,
|
|
336
340
|
unmarshalContactPoint,
|
|
337
341
|
unmarshalDataSource,
|
|
@@ -550,6 +550,18 @@ export type RegionalApiTriggerTestAlertRequest = {
|
|
|
550
550
|
/** ID of the Project. */
|
|
551
551
|
projectId?: string;
|
|
552
552
|
};
|
|
553
|
+
/** Update a data source name. */
|
|
554
|
+
export type RegionalApiUpdateDataSourceRequest = {
|
|
555
|
+
/**
|
|
556
|
+
* Region to target. If none is passed will use default region from the
|
|
557
|
+
* config.
|
|
558
|
+
*/
|
|
559
|
+
region?: Region;
|
|
560
|
+
/** ID of the data source to update. */
|
|
561
|
+
dataSourceId: string;
|
|
562
|
+
/** Updated name of the data source. */
|
|
563
|
+
name?: string;
|
|
564
|
+
};
|
|
553
565
|
export interface UsageOverview {
|
|
554
566
|
scalewayMetricsUsage?: Usage;
|
|
555
567
|
scalewayLogsUsage?: Usage;
|
|
@@ -50,9 +50,17 @@ const RegionalApiListTokensRequest = {
|
|
|
50
50
|
lessThanOrEqual: 1e3
|
|
51
51
|
}
|
|
52
52
|
};
|
|
53
|
+
const RegionalApiUpdateDataSourceRequest = {
|
|
54
|
+
name: {
|
|
55
|
+
maxLength: 50,
|
|
56
|
+
minLength: 3,
|
|
57
|
+
pattern: /^[A-Za-z0-9-_. ]+$/
|
|
58
|
+
}
|
|
59
|
+
};
|
|
53
60
|
exports.RegionalApiCreateDataSourceRequest = RegionalApiCreateDataSourceRequest;
|
|
54
61
|
exports.RegionalApiCreateTokenRequest = RegionalApiCreateTokenRequest;
|
|
55
62
|
exports.RegionalApiListContactPointsRequest = RegionalApiListContactPointsRequest;
|
|
56
63
|
exports.RegionalApiListDataSourcesRequest = RegionalApiListDataSourcesRequest;
|
|
57
64
|
exports.RegionalApiListManagedAlertsRequest = RegionalApiListManagedAlertsRequest;
|
|
58
65
|
exports.RegionalApiListTokensRequest = RegionalApiListTokensRequest;
|
|
66
|
+
exports.RegionalApiUpdateDataSourceRequest = RegionalApiUpdateDataSourceRequest;
|
|
@@ -48,11 +48,19 @@ const RegionalApiListTokensRequest = {
|
|
|
48
48
|
lessThanOrEqual: 1e3
|
|
49
49
|
}
|
|
50
50
|
};
|
|
51
|
+
const RegionalApiUpdateDataSourceRequest = {
|
|
52
|
+
name: {
|
|
53
|
+
maxLength: 50,
|
|
54
|
+
minLength: 3,
|
|
55
|
+
pattern: /^[A-Za-z0-9-_. ]+$/
|
|
56
|
+
}
|
|
57
|
+
};
|
|
51
58
|
export {
|
|
52
59
|
RegionalApiCreateDataSourceRequest,
|
|
53
60
|
RegionalApiCreateTokenRequest,
|
|
54
61
|
RegionalApiListContactPointsRequest,
|
|
55
62
|
RegionalApiListDataSourcesRequest,
|
|
56
63
|
RegionalApiListManagedAlertsRequest,
|
|
57
|
-
RegionalApiListTokensRequest
|
|
64
|
+
RegionalApiListTokensRequest,
|
|
65
|
+
RegionalApiUpdateDataSourceRequest
|
|
58
66
|
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * as v1alpha1 from './v1alpha1/index.gen';
|
|
@@ -0,0 +1,300 @@
|
|
|
1
|
+
import { API as ParentAPI } from '../../../bridge';
|
|
2
|
+
import type { WaitForOptions } from '../../../bridge';
|
|
3
|
+
import type { BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateTLSStageRequest, DNSStage, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteTLSStageRequest, GetBackendStageRequest, GetCacheStageRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetTLSStageRequest, ListBackendStagesRequest, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesResponse, ListPipelinesRequest, ListPipelinesResponse, ListPurgeRequestsRequest, ListPurgeRequestsResponse, ListTLSStagesRequest, ListTLSStagesResponse, Pipeline, PurgeRequest, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateTLSStageRequest } from './types.gen';
|
|
4
|
+
/** Edge Services API. */
|
|
5
|
+
export declare class API extends ParentAPI {
|
|
6
|
+
protected pageOfListPipelines: (request?: Readonly<ListPipelinesRequest>) => Promise<ListPipelinesResponse>;
|
|
7
|
+
/**
|
|
8
|
+
* List pipelines. List all pipelines, for a Scaleway Organization or Scaleway
|
|
9
|
+
* Project. By default, the pipelines returned in the list are ordered by
|
|
10
|
+
* creation date in ascending order, though this can be modified via the
|
|
11
|
+
* `order_by` field.
|
|
12
|
+
*
|
|
13
|
+
* @param request - The request {@link ListPipelinesRequest}
|
|
14
|
+
* @returns A Promise of ListPipelinesResponse
|
|
15
|
+
*/
|
|
16
|
+
listPipelines: (request?: Readonly<ListPipelinesRequest>) => Promise<ListPipelinesResponse> & {
|
|
17
|
+
all: () => Promise<Pipeline[]>;
|
|
18
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<Pipeline[], void, void>;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Create pipeline. Create a new pipeline. You must specify a `dns_stage_id`
|
|
22
|
+
* to form a stage-chain that goes all the way to the backend stage (origin),
|
|
23
|
+
* so the HTTP request will be processed according to the stages you created.
|
|
24
|
+
*
|
|
25
|
+
* @param request - The request {@link CreatePipelineRequest}
|
|
26
|
+
* @returns A Promise of Pipeline
|
|
27
|
+
*/
|
|
28
|
+
createPipeline: (request: Readonly<CreatePipelineRequest>) => Promise<Pipeline>;
|
|
29
|
+
/**
|
|
30
|
+
* Get pipeline. Retrieve information about an existing pipeline, specified by
|
|
31
|
+
* its `pipeline_id`. Its full details, including errors, are returned in the
|
|
32
|
+
* response object.
|
|
33
|
+
*
|
|
34
|
+
* @param request - The request {@link GetPipelineRequest}
|
|
35
|
+
* @returns A Promise of Pipeline
|
|
36
|
+
*/
|
|
37
|
+
getPipeline: (request: Readonly<GetPipelineRequest>) => Promise<Pipeline>;
|
|
38
|
+
/**
|
|
39
|
+
* Waits for {@link Pipeline} to be in a final state.
|
|
40
|
+
*
|
|
41
|
+
* @param request - The request {@link GetPipelineRequest}
|
|
42
|
+
* @param options - The waiting options
|
|
43
|
+
* @returns A Promise of Pipeline
|
|
44
|
+
*/
|
|
45
|
+
waitForPipeline: (request: Readonly<GetPipelineRequest>, options?: Readonly<WaitForOptions<Pipeline>>) => Promise<Pipeline>;
|
|
46
|
+
/**
|
|
47
|
+
* Update pipeline. Update the parameters of an existing pipeline, specified
|
|
48
|
+
* by its `pipeline_id`. Parameters which can be updated include the `name`,
|
|
49
|
+
* `description` and `dns_stage_id`.
|
|
50
|
+
*
|
|
51
|
+
* @param request - The request {@link UpdatePipelineRequest}
|
|
52
|
+
* @returns A Promise of Pipeline
|
|
53
|
+
*/
|
|
54
|
+
updatePipeline: (request: Readonly<UpdatePipelineRequest>) => Promise<Pipeline>;
|
|
55
|
+
/**
|
|
56
|
+
* Delete pipeline. Delete an existing pipeline, specified by its
|
|
57
|
+
* `pipeline_id`. Deleting a pipeline is permanent, and cannot be undone. Note
|
|
58
|
+
* that all stages linked to the pipeline are also deleted.
|
|
59
|
+
*
|
|
60
|
+
* @param request - The request {@link DeletePipelineRequest}
|
|
61
|
+
*/
|
|
62
|
+
deletePipeline: (request: Readonly<DeletePipelineRequest>) => Promise<void>;
|
|
63
|
+
protected pageOfListDNSStages: (request?: Readonly<ListDNSStagesRequest>) => Promise<ListDNSStagesResponse>;
|
|
64
|
+
/**
|
|
65
|
+
* List DNS stages. List all DNS stages, for a Scaleway Organization or
|
|
66
|
+
* Scaleway Project. By default, the DNS stages returned in the list are
|
|
67
|
+
* ordered by creation date in ascending order, though this can be modified
|
|
68
|
+
* via the `order_by` field.
|
|
69
|
+
*
|
|
70
|
+
* @param request - The request {@link ListDNSStagesRequest}
|
|
71
|
+
* @returns A Promise of ListDNSStagesResponse
|
|
72
|
+
*/
|
|
73
|
+
listDNSStages: (request?: Readonly<ListDNSStagesRequest>) => Promise<ListDNSStagesResponse> & {
|
|
74
|
+
all: () => Promise<DNSStage[]>;
|
|
75
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<DNSStage[], void, void>;
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
* Create DNS stage. Create a new DNS stage. You must specify the `fqdns`
|
|
79
|
+
* field to customize the domain endpoint, using a domain you already own.
|
|
80
|
+
*
|
|
81
|
+
* @param request - The request {@link CreateDNSStageRequest}
|
|
82
|
+
* @returns A Promise of DNSStage
|
|
83
|
+
*/
|
|
84
|
+
createDNSStage: (request?: Readonly<CreateDNSStageRequest>) => Promise<DNSStage>;
|
|
85
|
+
/**
|
|
86
|
+
* Get DNS stage. Retrieve information about an existing DNS stage, specified
|
|
87
|
+
* by its `dns_stage_id`. Its full details, including FQDNs, are returned in
|
|
88
|
+
* the response object.
|
|
89
|
+
*
|
|
90
|
+
* @param request - The request {@link GetDNSStageRequest}
|
|
91
|
+
* @returns A Promise of DNSStage
|
|
92
|
+
*/
|
|
93
|
+
getDNSStage: (request: Readonly<GetDNSStageRequest>) => Promise<DNSStage>;
|
|
94
|
+
/**
|
|
95
|
+
* Update DNS stage. Update the parameters of an existing DNS stage, specified
|
|
96
|
+
* by its `dns_stage_id`.
|
|
97
|
+
*
|
|
98
|
+
* @param request - The request {@link UpdateDNSStageRequest}
|
|
99
|
+
* @returns A Promise of DNSStage
|
|
100
|
+
*/
|
|
101
|
+
updateDNSStage: (request: Readonly<UpdateDNSStageRequest>) => Promise<DNSStage>;
|
|
102
|
+
/**
|
|
103
|
+
* Delete DNS stage. Delete an existing DNS stage, specified by its
|
|
104
|
+
* `dns_stage_id`. Deleting a DNS stage is permanent, and cannot be undone.
|
|
105
|
+
*
|
|
106
|
+
* @param request - The request {@link DeleteDNSStageRequest}
|
|
107
|
+
*/
|
|
108
|
+
deleteDNSStage: (request: Readonly<DeleteDNSStageRequest>) => Promise<void>;
|
|
109
|
+
protected pageOfListTLSStages: (request?: Readonly<ListTLSStagesRequest>) => Promise<ListTLSStagesResponse>;
|
|
110
|
+
/**
|
|
111
|
+
* List TLS stages. List all TLS stages, for a Scaleway Organization or
|
|
112
|
+
* Scaleway Project. By default, the TLS stages returned in the list are
|
|
113
|
+
* ordered by creation date in ascending order, though this can be modified
|
|
114
|
+
* via the `order_by` field.
|
|
115
|
+
*
|
|
116
|
+
* @param request - The request {@link ListTLSStagesRequest}
|
|
117
|
+
* @returns A Promise of ListTLSStagesResponse
|
|
118
|
+
*/
|
|
119
|
+
listTLSStages: (request?: Readonly<ListTLSStagesRequest>) => Promise<ListTLSStagesResponse> & {
|
|
120
|
+
all: () => Promise<TLSStage[]>;
|
|
121
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<TLSStage[], void, void>;
|
|
122
|
+
};
|
|
123
|
+
/**
|
|
124
|
+
* Create TLS stage. Create a new TLS stage. You must specify either the
|
|
125
|
+
* `secrets` or `managed_certificate` fields to customize the SSL/TLS
|
|
126
|
+
* certificate of your endpoint. Choose `secrets` if you are using a
|
|
127
|
+
* pre-existing certificate held in Scaleway Secret Manager, or
|
|
128
|
+
* `managed_certificate` to let Scaleway generate and manage a Let's Encrypt
|
|
129
|
+
* certificate for your customized endpoint.
|
|
130
|
+
*
|
|
131
|
+
* @param request - The request {@link CreateTLSStageRequest}
|
|
132
|
+
* @returns A Promise of TLSStage
|
|
133
|
+
*/
|
|
134
|
+
createTLSStage: (request?: Readonly<CreateTLSStageRequest>) => Promise<TLSStage>;
|
|
135
|
+
/**
|
|
136
|
+
* Get TLS stage. Retrieve information about an existing TLS stage, specified
|
|
137
|
+
* by its `tls_stage_id`. Its full details, including secrets and certificate
|
|
138
|
+
* expiration date are returned in the response object.
|
|
139
|
+
*
|
|
140
|
+
* @param request - The request {@link GetTLSStageRequest}
|
|
141
|
+
* @returns A Promise of TLSStage
|
|
142
|
+
*/
|
|
143
|
+
getTLSStage: (request: Readonly<GetTLSStageRequest>) => Promise<TLSStage>;
|
|
144
|
+
/**
|
|
145
|
+
* Update TLS stage. Update the parameters of an existing TLS stage, specified
|
|
146
|
+
* by its `tls_stage_id`. Both `tls_secrets_config` and `managed_certificate`
|
|
147
|
+
* parameters can be updated.
|
|
148
|
+
*
|
|
149
|
+
* @param request - The request {@link UpdateTLSStageRequest}
|
|
150
|
+
* @returns A Promise of TLSStage
|
|
151
|
+
*/
|
|
152
|
+
updateTLSStage: (request: Readonly<UpdateTLSStageRequest>) => Promise<TLSStage>;
|
|
153
|
+
/**
|
|
154
|
+
* Delete TLS stage. Delete an existing TLS stage, specified by its
|
|
155
|
+
* `tls_stage_id`. Deleting a TLS stage is permanent, and cannot be undone.
|
|
156
|
+
*
|
|
157
|
+
* @param request - The request {@link DeleteTLSStageRequest}
|
|
158
|
+
*/
|
|
159
|
+
deleteTLSStage: (request: Readonly<DeleteTLSStageRequest>) => Promise<void>;
|
|
160
|
+
protected pageOfListCacheStages: (request?: Readonly<ListCacheStagesRequest>) => Promise<ListCacheStagesResponse>;
|
|
161
|
+
/**
|
|
162
|
+
* List cache stages. List all cache stages, for a Scaleway Organization or
|
|
163
|
+
* Scaleway Project. By default, the cache stages returned in the list are
|
|
164
|
+
* ordered by creation date in ascending order, though this can be modified
|
|
165
|
+
* via the `order_by` field.
|
|
166
|
+
*
|
|
167
|
+
* @param request - The request {@link ListCacheStagesRequest}
|
|
168
|
+
* @returns A Promise of ListCacheStagesResponse
|
|
169
|
+
*/
|
|
170
|
+
listCacheStages: (request?: Readonly<ListCacheStagesRequest>) => Promise<ListCacheStagesResponse> & {
|
|
171
|
+
all: () => Promise<CacheStage[]>;
|
|
172
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<CacheStage[], void, void>;
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* Create cache stage. Create a new cache stage. You must specify the
|
|
176
|
+
* `fallback_ttl` field to customize the TTL of the cache.
|
|
177
|
+
*
|
|
178
|
+
* @param request - The request {@link CreateCacheStageRequest}
|
|
179
|
+
* @returns A Promise of CacheStage
|
|
180
|
+
*/
|
|
181
|
+
createCacheStage: (request?: Readonly<CreateCacheStageRequest>) => Promise<CacheStage>;
|
|
182
|
+
/**
|
|
183
|
+
* Get cache stage. Retrieve information about an existing cache stage,
|
|
184
|
+
* specified by its `cache_stage_id`. Its full details, including Time To Live
|
|
185
|
+
* (TTL), are returned in the response object.
|
|
186
|
+
*
|
|
187
|
+
* @param request - The request {@link GetCacheStageRequest}
|
|
188
|
+
* @returns A Promise of CacheStage
|
|
189
|
+
*/
|
|
190
|
+
getCacheStage: (request: Readonly<GetCacheStageRequest>) => Promise<CacheStage>;
|
|
191
|
+
/**
|
|
192
|
+
* Update cache stage. Update the parameters of an existing cache stage,
|
|
193
|
+
* specified by its `cache_stage_id`. Parameters which can be updated include
|
|
194
|
+
* the `fallback_ttl` and `backend_stage_id`.
|
|
195
|
+
*
|
|
196
|
+
* @param request - The request {@link UpdateCacheStageRequest}
|
|
197
|
+
* @returns A Promise of CacheStage
|
|
198
|
+
*/
|
|
199
|
+
updateCacheStage: (request: Readonly<UpdateCacheStageRequest>) => Promise<CacheStage>;
|
|
200
|
+
/**
|
|
201
|
+
* Delete cache stage. Delete an existing cache stage, specified by its
|
|
202
|
+
* `cache_stage_id`. Deleting a cache stage is permanent, and cannot be
|
|
203
|
+
* undone.
|
|
204
|
+
*
|
|
205
|
+
* @param request - The request {@link DeleteCacheStageRequest}
|
|
206
|
+
*/
|
|
207
|
+
deleteCacheStage: (request: Readonly<DeleteCacheStageRequest>) => Promise<void>;
|
|
208
|
+
protected pageOfListBackendStages: (request?: Readonly<ListBackendStagesRequest>) => Promise<ListBackendStagesResponse>;
|
|
209
|
+
/**
|
|
210
|
+
* List backend stages. List all backend stages, for a Scaleway Organization
|
|
211
|
+
* or Scaleway Project. By default, the backend stages returned in the list
|
|
212
|
+
* are ordered by creation date in ascending order, though this can be
|
|
213
|
+
* modified via the `order_by` field.
|
|
214
|
+
*
|
|
215
|
+
* @param request - The request {@link ListBackendStagesRequest}
|
|
216
|
+
* @returns A Promise of ListBackendStagesResponse
|
|
217
|
+
*/
|
|
218
|
+
listBackendStages: (request?: Readonly<ListBackendStagesRequest>) => Promise<ListBackendStagesResponse> & {
|
|
219
|
+
all: () => Promise<BackendStage[]>;
|
|
220
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<BackendStage[], void, void>;
|
|
221
|
+
};
|
|
222
|
+
/**
|
|
223
|
+
* Create backend stage. Create a new backend stage. You must specify either a
|
|
224
|
+
* `scaleway_s3` (for a Scaleway Object Storage bucket) or `scaleway_lb` (for
|
|
225
|
+
* a Scaleway Load Balancer) field to configure the origin.
|
|
226
|
+
*
|
|
227
|
+
* @param request - The request {@link CreateBackendStageRequest}
|
|
228
|
+
* @returns A Promise of BackendStage
|
|
229
|
+
*/
|
|
230
|
+
createBackendStage: (request?: Readonly<CreateBackendStageRequest>) => Promise<BackendStage>;
|
|
231
|
+
/**
|
|
232
|
+
* Get backend stage. Retrieve information about an existing backend stage,
|
|
233
|
+
* specified by its `backend_stage_id`. Its full details, including
|
|
234
|
+
* `scaleway_s3` or `scaleway_lb`, are returned in the response object.
|
|
235
|
+
*
|
|
236
|
+
* @param request - The request {@link GetBackendStageRequest}
|
|
237
|
+
* @returns A Promise of BackendStage
|
|
238
|
+
*/
|
|
239
|
+
getBackendStage: (request: Readonly<GetBackendStageRequest>) => Promise<BackendStage>;
|
|
240
|
+
/**
|
|
241
|
+
* Update backend stage. Update the parameters of an existing backend stage,
|
|
242
|
+
* specified by its `backend_stage_id`.
|
|
243
|
+
*
|
|
244
|
+
* @param request - The request {@link UpdateBackendStageRequest}
|
|
245
|
+
* @returns A Promise of BackendStage
|
|
246
|
+
*/
|
|
247
|
+
updateBackendStage: (request: Readonly<UpdateBackendStageRequest>) => Promise<BackendStage>;
|
|
248
|
+
/**
|
|
249
|
+
* Delete backend stage. Delete an existing backend stage, specified by its
|
|
250
|
+
* `backend_stage_id`. Deleting a backend stage is permanent, and cannot be
|
|
251
|
+
* undone.
|
|
252
|
+
*
|
|
253
|
+
* @param request - The request {@link DeleteBackendStageRequest}
|
|
254
|
+
*/
|
|
255
|
+
deleteBackendStage: (request: Readonly<DeleteBackendStageRequest>) => Promise<void>;
|
|
256
|
+
checkDomain: (request: Readonly<CheckDomainRequest>) => Promise<CheckDomainResponse>;
|
|
257
|
+
checkPEMChain: (request: Readonly<CheckPEMChainRequest>) => Promise<CheckPEMChainResponse>;
|
|
258
|
+
protected pageOfListPurgeRequests: (request?: Readonly<ListPurgeRequestsRequest>) => Promise<ListPurgeRequestsResponse>;
|
|
259
|
+
/**
|
|
260
|
+
* List purge requests. List all purge requests, for a Scaleway Organization
|
|
261
|
+
* or Scaleway Project. This enables you to retrieve a history of all
|
|
262
|
+
* previously-made purge requests. By default, the purge requests returned in
|
|
263
|
+
* the list are ordered by creation date in ascending order, though this can
|
|
264
|
+
* be modified via the `order_by` field.
|
|
265
|
+
*
|
|
266
|
+
* @param request - The request {@link ListPurgeRequestsRequest}
|
|
267
|
+
* @returns A Promise of ListPurgeRequestsResponse
|
|
268
|
+
*/
|
|
269
|
+
listPurgeRequests: (request?: Readonly<ListPurgeRequestsRequest>) => Promise<ListPurgeRequestsResponse> & {
|
|
270
|
+
all: () => Promise<PurgeRequest[]>;
|
|
271
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<PurgeRequest[], void, void>;
|
|
272
|
+
};
|
|
273
|
+
/**
|
|
274
|
+
* Create purge request. Create a new purge request. You must specify either
|
|
275
|
+
* the `all` field (to purge all content) or a list of `assets` (to define the
|
|
276
|
+
* precise assets to purge).
|
|
277
|
+
*
|
|
278
|
+
* @param request - The request {@link CreatePurgeRequestRequest}
|
|
279
|
+
* @returns A Promise of PurgeRequest
|
|
280
|
+
*/
|
|
281
|
+
createPurgeRequest: (request: Readonly<CreatePurgeRequestRequest>) => Promise<PurgeRequest>;
|
|
282
|
+
/**
|
|
283
|
+
* Get purge request. Retrieve information about a purge request, specified by
|
|
284
|
+
* its `purge_request_id`. Its full details, including `status` and `target`,
|
|
285
|
+
* are returned in the response object.
|
|
286
|
+
*
|
|
287
|
+
* @param request - The request {@link GetPurgeRequestRequest}
|
|
288
|
+
* @returns A Promise of PurgeRequest
|
|
289
|
+
*/
|
|
290
|
+
getPurgeRequest: (request: Readonly<GetPurgeRequestRequest>) => Promise<PurgeRequest>;
|
|
291
|
+
/**
|
|
292
|
+
* Waits for {@link PurgeRequest} to be in a final state.
|
|
293
|
+
*
|
|
294
|
+
* @param request - The request {@link GetPurgeRequestRequest}
|
|
295
|
+
* @param options - The waiting options
|
|
296
|
+
* @returns A Promise of PurgeRequest
|
|
297
|
+
*/
|
|
298
|
+
waitForPurgeRequest: (request: Readonly<GetPurgeRequestRequest>, options?: Readonly<WaitForOptions<PurgeRequest>>) => Promise<PurgeRequest>;
|
|
299
|
+
checkLbOrigin: (request?: Readonly<CheckLbOriginRequest>) => Promise<CheckLbOriginResponse>;
|
|
300
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { PipelineStatus, PurgeRequestStatus } from './types.gen';
|
|
2
|
+
/** Lists transient statutes of the enum {@link PipelineStatus}. */
|
|
3
|
+
export declare const PIPELINE_TRANSIENT_STATUSES: PipelineStatus[];
|
|
4
|
+
/** Lists transient statutes of the enum {@link PurgeRequestStatus}. */
|
|
5
|
+
export declare const PURGE_REQUEST_TRANSIENT_STATUSES: PurgeRequestStatus[];
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { API } from './api.gen';
|
|
2
|
+
export * from './content.gen';
|
|
3
|
+
export type { BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainRequestSecretChain, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateTLSStageRequest, DNSStage, DNSStageType, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteTLSStageRequest, GetBackendStageRequest, GetCacheStageRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetTLSStageRequest, LbOriginError, ListBackendStagesRequest, ListBackendStagesRequestOrderBy, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesRequestOrderBy, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesRequestOrderBy, ListDNSStagesResponse, ListPipelinesRequest, ListPipelinesRequestOrderBy, ListPipelinesResponse, ListPurgeRequestsRequest, ListPurgeRequestsRequestOrderBy, ListPurgeRequestsResponse, ListTLSStagesRequest, ListTLSStagesRequestOrderBy, ListTLSStagesResponse, Pipeline, PipelineError, PipelineErrorCode, PipelineErrorSeverity, PipelineErrorStage, PipelineErrorType, PipelineStatus, PurgeRequest, PurgeRequestStatus, ScalewayLb, ScalewayLbBackendConfig, ScalewayS3BackendConfig, TLSSecret, TLSSecretsConfig, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateTLSStageRequest, } from './types.gen';
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { DefaultValues } from '../../../bridge';
|
|
2
|
+
import type { BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateTLSStageRequest, DNSStage, ListBackendStagesResponse, ListCacheStagesResponse, ListDNSStagesResponse, ListPipelinesResponse, ListPurgeRequestsResponse, ListTLSStagesResponse, Pipeline, PurgeRequest, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateTLSStageRequest } from './types.gen';
|
|
3
|
+
export declare const unmarshalBackendStage: (data: unknown) => BackendStage;
|
|
4
|
+
export declare const unmarshalCacheStage: (data: unknown) => CacheStage;
|
|
5
|
+
export declare const unmarshalDNSStage: (data: unknown) => DNSStage;
|
|
6
|
+
export declare const unmarshalPipeline: (data: unknown) => Pipeline;
|
|
7
|
+
export declare const unmarshalPurgeRequest: (data: unknown) => PurgeRequest;
|
|
8
|
+
export declare const unmarshalTLSStage: (data: unknown) => TLSStage;
|
|
9
|
+
export declare const unmarshalCheckDomainResponse: (data: unknown) => CheckDomainResponse;
|
|
10
|
+
export declare const unmarshalCheckLbOriginResponse: (data: unknown) => CheckLbOriginResponse;
|
|
11
|
+
export declare const unmarshalCheckPEMChainResponse: (data: unknown) => CheckPEMChainResponse;
|
|
12
|
+
export declare const unmarshalListBackendStagesResponse: (data: unknown) => ListBackendStagesResponse;
|
|
13
|
+
export declare const unmarshalListCacheStagesResponse: (data: unknown) => ListCacheStagesResponse;
|
|
14
|
+
export declare const unmarshalListDNSStagesResponse: (data: unknown) => ListDNSStagesResponse;
|
|
15
|
+
export declare const unmarshalListPipelinesResponse: (data: unknown) => ListPipelinesResponse;
|
|
16
|
+
export declare const unmarshalListPurgeRequestsResponse: (data: unknown) => ListPurgeRequestsResponse;
|
|
17
|
+
export declare const unmarshalListTLSStagesResponse: (data: unknown) => ListTLSStagesResponse;
|
|
18
|
+
export declare const marshalCheckDomainRequest: (request: CheckDomainRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
19
|
+
export declare const marshalCheckLbOriginRequest: (request: CheckLbOriginRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
20
|
+
export declare const marshalCheckPEMChainRequest: (request: CheckPEMChainRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
21
|
+
export declare const marshalCreateBackendStageRequest: (request: CreateBackendStageRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
22
|
+
export declare const marshalCreateCacheStageRequest: (request: CreateCacheStageRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
23
|
+
export declare const marshalCreateDNSStageRequest: (request: CreateDNSStageRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
24
|
+
export declare const marshalCreatePipelineRequest: (request: CreatePipelineRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
25
|
+
export declare const marshalCreatePurgeRequestRequest: (request: CreatePurgeRequestRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
26
|
+
export declare const marshalCreateTLSStageRequest: (request: CreateTLSStageRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
27
|
+
export declare const marshalUpdateBackendStageRequest: (request: UpdateBackendStageRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
28
|
+
export declare const marshalUpdateCacheStageRequest: (request: UpdateCacheStageRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
29
|
+
export declare const marshalUpdateDNSStageRequest: (request: UpdateDNSStageRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
30
|
+
export declare const marshalUpdatePipelineRequest: (request: UpdatePipelineRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
31
|
+
export declare const marshalUpdateTLSStageRequest: (request: UpdateTLSStageRequest, defaults: DefaultValues) => Record<string, unknown>;
|