@scaleway/sdk-edge-services 2.2.0 → 2.4.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.
@@ -57,6 +57,12 @@ export declare class API extends ParentAPI {
57
57
  */
58
58
  deletePipeline: (request: Readonly<DeletePipelineRequest>) => Promise<void>;
59
59
  protected pageOfListHeadStages: (request: Readonly<ListHeadStagesRequest>) => Promise<ListHeadStagesResponse>;
60
+ /**
61
+ * List Head stage for your pipeline.. List Head stage for your pipeline.
62
+ *
63
+ * @param request - The request {@link ListHeadStagesRequest}
64
+ * @returns A Promise of ListHeadStagesResponse
65
+ */
60
66
  listHeadStages: (request: Readonly<ListHeadStagesRequest>) => Promise<ListHeadStagesResponse> & {
61
67
  all: () => Promise<import("./types.gen.js").ListHeadStagesResponseHeadStage[]>;
62
68
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").ListHeadStagesResponseHeadStage[], void, void>;
@@ -139,6 +139,12 @@ class API extends API$1 {
139
139
  },
140
140
  unmarshalListHeadStagesResponse
141
141
  );
142
+ /**
143
+ * List Head stage for your pipeline.. List Head stage for your pipeline.
144
+ *
145
+ * @param request - The request {@link ListHeadStagesRequest}
146
+ * @returns A Promise of ListHeadStagesResponse
147
+ */
142
148
  listHeadStages = (request) => enrichForPagination("headStages", this.pageOfListHeadStages, request);
143
149
  /**
144
150
  * Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.. You must specify either a `add_new_head_stage` (to add a new head stage), `remove_head_stage` (to remove a head stage) or `swap_head_stage` (to replace a head stage).
@@ -1,5 +1,5 @@
1
1
  export { API } from './api.gen.js';
2
2
  export * from './content.gen.js';
3
3
  export * from './marshalling.gen.js';
4
- export type { AddRouteRulesRequest, AddRouteRulesResponse, BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainRequestSecretChain, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateRouteStageRequest, CreateTLSStageRequest, CreateWafStageRequest, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteCurrentPlanRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteRouteStageRequest, DeleteTLSStageRequest, DeleteWafStageRequest, DNSStage, DNSStageType, GetBackendStageRequest, GetBillingRequest, GetBillingResponse, GetCacheStageRequest, GetCurrentPlanRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetRouteStageRequest, GetTLSStageRequest, GetWafStageRequest, HeadStageResponse, HeadStageResponseHeadStage, LbOriginError, ListBackendStagesRequest, ListBackendStagesRequestOrderBy, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesRequestOrderBy, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesRequestOrderBy, ListDNSStagesResponse, ListHeadStagesRequest, ListHeadStagesResponse, ListHeadStagesResponseHeadStage, ListPipelinesRequest, ListPipelinesRequestOrderBy, ListPipelinesResponse, ListPipelinesWithStagesRequest, ListPipelinesWithStagesRequestOrderBy, ListPipelinesWithStagesResponse, ListPlansResponse, ListPurgeRequestsRequest, ListPurgeRequestsRequestOrderBy, ListPurgeRequestsResponse, ListRouteRulesRequest, ListRouteRulesResponse, ListRouteStagesRequest, ListRouteStagesRequestOrderBy, ListRouteStagesResponse, ListTLSStagesRequest, ListTLSStagesRequestOrderBy, ListTLSStagesResponse, ListWafStagesRequest, ListWafStagesRequestOrderBy, ListWafStagesResponse, Pipeline, PipelineError, PipelineErrorCode, PipelineErrorSeverity, PipelineErrorStage, PipelineErrorType, PipelineStages, PipelineStatus, Plan, PlanDetails, PlanName, PlanUsageDetails, PurgeRequest, PurgeRequestStatus, RouteRule, RouteStage, RuleHttpMatch, RuleHttpMatchMethodFilter, RuleHttpMatchPathFilter, RuleHttpMatchPathFilterPathFilterType, ScalewayLb, ScalewayLbBackendConfig, ScalewayS3BackendConfig, ScalewayServerlessContainerBackendConfig, SearchBackendStagesRequest, SearchBackendStagesRequestOrderBy, SearchRouteRulesRequest, SearchRouteRulesRequestOrderBy, SearchWafStagesRequest, SearchWafStagesRequestOrderBy, SelectPlanRequest, SetHeadStageRequest, SetHeadStageRequestAddNewHeadStage, SetHeadStageRequestRemoveHeadStage, SetHeadStageRequestSwapHeadStage, SetRouteRulesRequest, SetRouteRulesRequestRouteRule, SetRouteRulesResponse, TLSSecret, TLSSecretsConfig, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateRouteStageRequest, UpdateTLSStageRequest, UpdateWafStageRequest, WafStage, WafStageMode, } from './types.gen.js';
4
+ export type { AddRouteRulesRequest, AddRouteRulesResponse, BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainRequestSecretChain, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateRouteStageRequest, CreateTLSStageRequest, CreateWafStageRequest, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteCurrentPlanRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteRouteStageRequest, DeleteTLSStageRequest, DeleteWafStageRequest, DNSStage, DNSStageType, GetBackendStageRequest, GetBillingRequest, GetBillingResponse, GetCacheStageRequest, GetCurrentPlanRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetRouteStageRequest, GetTLSStageRequest, GetWafStageRequest, HeadStageResponse, HeadStageResponseHeadStage, LbOriginError, ListBackendStagesRequest, ListBackendStagesRequestOrderBy, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesRequestOrderBy, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesRequestOrderBy, ListDNSStagesResponse, ListHeadStagesRequest, ListHeadStagesResponse, ListHeadStagesResponseHeadStage, ListPipelinesRequest, ListPipelinesRequestOrderBy, ListPipelinesResponse, ListPipelinesWithStagesRequest, ListPipelinesWithStagesRequestOrderBy, ListPipelinesWithStagesResponse, ListPlansResponse, ListPurgeRequestsRequest, ListPurgeRequestsRequestOrderBy, ListPurgeRequestsResponse, ListRouteRulesRequest, ListRouteRulesResponse, ListRouteStagesRequest, ListRouteStagesRequestOrderBy, ListRouteStagesResponse, ListTLSStagesRequest, ListTLSStagesRequestOrderBy, ListTLSStagesResponse, ListWafStagesRequest, ListWafStagesRequestOrderBy, ListWafStagesResponse, Pipeline, PipelineError, PipelineErrorCode, PipelineErrorSeverity, PipelineErrorStage, PipelineErrorType, PipelineStages, PipelineStatus, Plan, PlanDetails, PlanName, PlanUsageDetails, PurgeRequest, PurgeRequestStatus, RouteRule, RouteStage, RuleHttpMatch, RuleHttpMatchMethodFilter, RuleHttpMatchPathFilter, RuleHttpMatchPathFilterPathFilterType, ScalewayLb, ScalewayLbBackendConfig, ScalewayS3BackendConfig, ScalewayServerlessContainerBackendConfig, ScalewayServerlessFunctionBackendConfig, SearchBackendStagesRequest, SearchBackendStagesRequestOrderBy, SearchRouteRulesRequest, SearchRouteRulesRequestOrderBy, SearchWafStagesRequest, SearchWafStagesRequestOrderBy, SelectPlanRequest, SetHeadStageRequest, SetHeadStageRequestAddNewHeadStage, SetHeadStageRequestRemoveHeadStage, SetHeadStageRequestSwapHeadStage, SetRouteRulesRequest, SetRouteRulesRequestRouteRule, SetRouteRulesResponse, TLSSecret, TLSSecretsConfig, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateRouteStageRequest, UpdateTLSStageRequest, UpdateWafStageRequest, WafStage, WafStageMode, } from './types.gen.js';
5
5
  export * as ValidationRules from './validation-rules.gen.js';
@@ -47,6 +47,17 @@ const unmarshalScalewayServerlessContainerBackendConfig = (data) => {
47
47
  region: data.region
48
48
  };
49
49
  };
50
+ const unmarshalScalewayServerlessFunctionBackendConfig = (data) => {
51
+ if (!isJSONObject(data)) {
52
+ throw new TypeError(
53
+ `Unmarshalling the type 'ScalewayServerlessFunctionBackendConfig' failed as data isn't a dictionary.`
54
+ );
55
+ }
56
+ return {
57
+ functionId: data.function_id,
58
+ region: data.region
59
+ };
60
+ };
50
61
  const unmarshalBackendStage = (data) => {
51
62
  if (!isJSONObject(data)) {
52
63
  throw new TypeError(
@@ -62,6 +73,9 @@ const unmarshalBackendStage = (data) => {
62
73
  scalewayServerlessContainer: data.scaleway_serverless_container ? unmarshalScalewayServerlessContainerBackendConfig(
63
74
  data.scaleway_serverless_container
64
75
  ) : void 0,
76
+ scalewayServerlessFunction: data.scaleway_serverless_function ? unmarshalScalewayServerlessFunctionBackendConfig(
77
+ data.scaleway_serverless_function
78
+ ) : void 0,
65
79
  updatedAt: unmarshalDate(data.updated_at)
66
80
  };
67
81
  };
@@ -613,6 +627,10 @@ const marshalScalewayServerlessContainerBackendConfig = (request, defaults) => (
613
627
  container_id: request.containerId,
614
628
  region: request.region
615
629
  });
630
+ const marshalScalewayServerlessFunctionBackendConfig = (request, defaults) => ({
631
+ function_id: request.functionId,
632
+ region: request.region
633
+ });
616
634
  const marshalCreateBackendStageRequest = (request, defaults) => ({
617
635
  ...resolveOneOf([
618
636
  {
@@ -628,6 +646,12 @@ const marshalCreateBackendStageRequest = (request, defaults) => ({
628
646
  value: request.scalewayServerlessContainer !== void 0 ? marshalScalewayServerlessContainerBackendConfig(
629
647
  request.scalewayServerlessContainer
630
648
  ) : void 0
649
+ },
650
+ {
651
+ param: "scaleway_serverless_function",
652
+ value: request.scalewayServerlessFunction !== void 0 ? marshalScalewayServerlessFunctionBackendConfig(
653
+ request.scalewayServerlessFunction
654
+ ) : void 0
631
655
  }
632
656
  ])
633
657
  });
@@ -741,6 +765,12 @@ const marshalUpdateBackendStageRequest = (request, defaults) => ({
741
765
  value: request.scalewayServerlessContainer !== void 0 ? marshalScalewayServerlessContainerBackendConfig(
742
766
  request.scalewayServerlessContainer
743
767
  ) : void 0
768
+ },
769
+ {
770
+ param: "scaleway_serverless_function",
771
+ value: request.scalewayServerlessFunction !== void 0 ? marshalScalewayServerlessFunctionBackendConfig(
772
+ request.scalewayServerlessFunction
773
+ ) : void 0
744
774
  }
745
775
  ])
746
776
  });
@@ -86,6 +86,13 @@ export interface ScalewayServerlessContainerBackendConfig {
86
86
  region: ScwRegion;
87
87
  containerId: string;
88
88
  }
89
+ export interface ScalewayServerlessFunctionBackendConfig {
90
+ /**
91
+ * Region to target. If none is passed will use default region from the config.
92
+ */
93
+ region: ScwRegion;
94
+ functionId: string;
95
+ }
89
96
  export interface PipelineError {
90
97
  stage: PipelineErrorStage;
91
98
  code: PipelineErrorCode;
@@ -133,20 +140,25 @@ export interface BackendStage {
133
140
  /**
134
141
  * Scaleway Object Storage origin bucket (S3) linked to the backend stage.
135
142
  *
136
- * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer' could be set.
143
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
137
144
  */
138
145
  scalewayS3?: ScalewayS3BackendConfig;
139
146
  /**
140
147
  * Scaleway Load Balancer origin linked to the backend stage.
141
148
  *
142
- * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer' could be set.
149
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
143
150
  */
144
151
  scalewayLb?: ScalewayLbBackendConfig;
145
152
  /**
146
153
  *
147
- * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer' could be set.
154
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
148
155
  */
149
156
  scalewayServerlessContainer?: ScalewayServerlessContainerBackendConfig;
157
+ /**
158
+ *
159
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
160
+ */
161
+ scalewayServerlessFunction?: ScalewayServerlessFunctionBackendConfig;
150
162
  }
151
163
  export interface CacheStage {
152
164
  /**
@@ -589,20 +601,25 @@ export type CreateBackendStageRequest = {
589
601
  /**
590
602
  * Scaleway Object Storage origin bucket (S3) linked to the backend stage.
591
603
  *
592
- * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer' could be set.
604
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
593
605
  */
594
606
  scalewayS3?: ScalewayS3BackendConfig;
595
607
  /**
596
608
  * Scaleway Load Balancer origin linked to the backend stage.
597
609
  *
598
- * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer' could be set.
610
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
599
611
  */
600
612
  scalewayLb?: ScalewayLbBackendConfig;
601
613
  /**
602
614
  *
603
- * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer' could be set.
615
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
604
616
  */
605
617
  scalewayServerlessContainer?: ScalewayServerlessContainerBackendConfig;
618
+ /**
619
+ *
620
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
621
+ */
622
+ scalewayServerlessFunction?: ScalewayServerlessFunctionBackendConfig;
606
623
  };
607
624
  export type CreateCacheStageRequest = {
608
625
  /**
@@ -1322,24 +1339,29 @@ export type UpdateBackendStageRequest = {
1322
1339
  /**
1323
1340
  * Scaleway Object Storage origin bucket (S3) linked to the backend stage.
1324
1341
  *
1325
- * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer' could be set.
1342
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
1326
1343
  */
1327
1344
  scalewayS3?: ScalewayS3BackendConfig;
1328
1345
  /**
1329
1346
  * Scaleway Load Balancer origin linked to the backend stage.
1330
1347
  *
1331
- * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer' could be set.
1348
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
1332
1349
  */
1333
1350
  scalewayLb?: ScalewayLbBackendConfig;
1334
1351
  /**
1335
- * Pipeline ID the Backend stage belongs to.
1352
+ *
1353
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
1336
1354
  */
1337
- pipelineId: string;
1355
+ scalewayServerlessContainer?: ScalewayServerlessContainerBackendConfig;
1338
1356
  /**
1339
1357
  *
1340
- * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer' could be set.
1358
+ * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb', 'scalewayServerlessContainer', 'scalewayServerlessFunction' could be set.
1341
1359
  */
1342
- scalewayServerlessContainer?: ScalewayServerlessContainerBackendConfig;
1360
+ scalewayServerlessFunction?: ScalewayServerlessFunctionBackendConfig;
1361
+ /**
1362
+ * Pipeline ID the Backend stage belongs to.
1363
+ */
1364
+ pipelineId: string;
1343
1365
  };
1344
1366
  export type UpdateCacheStageRequest = {
1345
1367
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk-edge-services",
3
- "version": "2.2.0",
3
+ "version": "2.4.0",
4
4
  "description": "Scaleway SDK edge-services",
5
5
  "license": "Apache-2.0",
6
6
  "files": [