@scaleway/sdk-edge-services 1.1.0 → 1.2.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.
@@ -721,6 +721,29 @@ class API extends sdkClient.API {
721
721
  },
722
722
  marshalling_gen.unmarshalAddRouteRulesResponse
723
723
  );
724
+ /**
725
+ * List route rules. List all route rules of an organization or project.
726
+ *
727
+ * @param request - The request {@link SearchRouteRulesRequest}
728
+ * @returns A Promise of ListRouteRulesResponse
729
+ */
730
+ searchRouteRules = (request = {}) => this.client.fetch(
731
+ {
732
+ method: "GET",
733
+ path: `/edge-services/v1beta1/search-route-rules`,
734
+ urlParams: sdkClient.urlParams(
735
+ ["order_by", request.orderBy],
736
+ ["organization_id", request.organizationId],
737
+ ["page", request.page],
738
+ [
739
+ "page_size",
740
+ request.pageSize ?? this.client.settings.defaultPageSize
741
+ ],
742
+ ["project_id", request.projectId]
743
+ )
744
+ },
745
+ marshalling_gen.unmarshalListRouteRulesResponse
746
+ );
724
747
  checkDomain = (request) => this.client.fetch(
725
748
  {
726
749
  body: JSON.stringify(
@@ -1,6 +1,6 @@
1
- import { API as ParentAPI } from '@scaleway/sdk-client';
2
1
  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, SearchWafStagesRequest, SelectPlanRequest, SetHeadStageRequest, SetRouteRulesRequest, SetRouteRulesResponse, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateRouteStageRequest, UpdateTLSStageRequest, UpdateWafStageRequest, WafStage } from './types.gen';
2
+ import { API as ParentAPI } 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, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteCurrentPlanRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteRouteStageRequest, DeleteTLSStageRequest, DeleteWafStageRequest, DNSStage, 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, SearchRouteRulesRequest, 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
  */
@@ -319,6 +319,13 @@ export declare class API extends ParentAPI {
319
319
  * @returns A Promise of AddRouteRulesResponse
320
320
  */
321
321
  addRouteRules: (request: Readonly<AddRouteRulesRequest>) => Promise<AddRouteRulesResponse>;
322
+ /**
323
+ * List route rules. List all route rules of an organization or project.
324
+ *
325
+ * @param request - The request {@link SearchRouteRulesRequest}
326
+ * @returns A Promise of ListRouteRulesResponse
327
+ */
328
+ searchRouteRules: (request?: Readonly<SearchRouteRulesRequest>) => Promise<ListRouteRulesResponse>;
322
329
  checkDomain: (request: Readonly<CheckDomainRequest>) => Promise<CheckDomainResponse>;
323
330
  checkPEMChain: (request: Readonly<CheckPEMChainRequest>) => Promise<CheckPEMChainResponse>;
324
331
  protected pageOfListPurgeRequests: (request?: Readonly<ListPurgeRequestsRequest>) => Promise<ListPurgeRequestsResponse>;
@@ -719,6 +719,29 @@ class API extends API$1 {
719
719
  },
720
720
  unmarshalAddRouteRulesResponse
721
721
  );
722
+ /**
723
+ * List route rules. List all route rules of an organization or project.
724
+ *
725
+ * @param request - The request {@link SearchRouteRulesRequest}
726
+ * @returns A Promise of ListRouteRulesResponse
727
+ */
728
+ searchRouteRules = (request = {}) => this.client.fetch(
729
+ {
730
+ method: "GET",
731
+ path: `/edge-services/v1beta1/search-route-rules`,
732
+ urlParams: urlParams(
733
+ ["order_by", request.orderBy],
734
+ ["organization_id", request.organizationId],
735
+ ["page", request.page],
736
+ [
737
+ "page_size",
738
+ request.pageSize ?? this.client.settings.defaultPageSize
739
+ ],
740
+ ["project_id", request.projectId]
741
+ )
742
+ },
743
+ unmarshalListRouteRulesResponse
744
+ );
722
745
  checkDomain = (request) => this.client.fetch(
723
746
  {
724
747
  body: JSON.stringify(
@@ -1,5 +1,5 @@
1
1
  export { API } from './api.gen';
2
2
  export * from './content.gen';
3
3
  export * from './marshalling.gen';
4
- export type { AddRouteRulesRequest, AddRouteRulesResponse, BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainRequestSecretChain, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateRouteStageRequest, CreateTLSStageRequest, CreateWafStageRequest, DNSStage, DNSStageType, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteCurrentPlanRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteRouteStageRequest, DeleteTLSStageRequest, DeleteWafStageRequest, 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, SearchBackendStagesRequest, SearchBackendStagesRequestOrderBy, 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';
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, 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';
5
5
  export * as ValidationRules from './validation-rules.gen';
@@ -471,7 +471,8 @@ const unmarshalListRouteRulesResponse = (data) => {
471
471
  );
472
472
  }
473
473
  return {
474
- routeRules: sdkClient.unmarshalArrayOfObject(data.route_rules, unmarshalRouteRule)
474
+ routeRules: sdkClient.unmarshalArrayOfObject(data.route_rules, unmarshalRouteRule),
475
+ totalCount: data.total_count
475
476
  };
476
477
  };
477
478
  const unmarshalListRouteStagesResponse = (data) => {
@@ -469,7 +469,8 @@ const unmarshalListRouteRulesResponse = (data) => {
469
469
  );
470
470
  }
471
471
  return {
472
- routeRules: unmarshalArrayOfObject(data.route_rules, unmarshalRouteRule)
472
+ routeRules: unmarshalArrayOfObject(data.route_rules, unmarshalRouteRule),
473
+ totalCount: data.total_count
473
474
  };
474
475
  };
475
476
  const unmarshalListRouteStagesResponse = (data) => {
@@ -20,6 +20,7 @@ export type PurgeRequestStatus = 'unknown_status' | 'done' | 'error' | 'pending'
20
20
  export type RuleHttpMatchMethodFilter = 'unknown_method_filter' | 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options';
21
21
  export type RuleHttpMatchPathFilterPathFilterType = 'unknown_path_filter' | 'regex';
22
22
  export type SearchBackendStagesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
23
+ export type SearchRouteRulesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
23
24
  export type SearchWafStagesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
24
25
  export type WafStageMode = 'unknown_mode' | 'disable' | 'log_only' | 'enable';
25
26
  export interface ScalewayLb {
@@ -1122,6 +1123,10 @@ export interface ListRouteRulesResponse {
1122
1123
  * List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
1123
1124
  */
1124
1125
  routeRules: RouteRule[];
1126
+ /**
1127
+ * Count of all route rules matching the requested criteria.
1128
+ */
1129
+ totalCount: number;
1125
1130
  }
1126
1131
  export type ListRouteStagesRequest = {
1127
1132
  /**
@@ -1227,6 +1232,13 @@ export type SearchBackendStagesRequest = {
1227
1232
  bucketRegion?: string;
1228
1233
  lbId?: string;
1229
1234
  };
1235
+ export type SearchRouteRulesRequest = {
1236
+ orderBy?: SearchRouteRulesRequestOrderBy;
1237
+ page?: number;
1238
+ pageSize?: number;
1239
+ organizationId?: string;
1240
+ projectId?: string;
1241
+ };
1230
1242
  export type SearchWafStagesRequest = {
1231
1243
  orderBy?: SearchWafStagesRequestOrderBy;
1232
1244
  page?: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk-edge-services",
3
- "version": "1.1.0",
3
+ "version": "1.2.0",
4
4
  "description": "Scaleway SDK edge-services",
5
5
  "license": "Apache-2.0",
6
6
  "files": [
@@ -26,17 +26,17 @@
26
26
  "directory": "packages_generated/edge-services"
27
27
  },
28
28
  "engines": {
29
- "node": ">=20.19.1"
29
+ "node": ">=20.19.4"
30
30
  },
31
31
  "dependencies": {
32
- "@scaleway/random-name": "5.1.1",
33
- "@scaleway/sdk-std": "1.0.5"
32
+ "@scaleway/random-name": "5.1.2",
33
+ "@scaleway/sdk-std": "1.0.6"
34
34
  },
35
35
  "peerDependencies": {
36
- "@scaleway/sdk-client": "^1.3.0"
36
+ "@scaleway/sdk-client": "^1.3.1"
37
37
  },
38
38
  "devDependencies": {
39
- "@scaleway/sdk-client": "^1.3.0"
39
+ "@scaleway/sdk-client": "^1.3.1"
40
40
  },
41
41
  "scripts": {
42
42
  "package:check": "pnpm publint",