@scaleway/sdk-edge-services 1.0.5 → 1.2.0

package/dist/v1beta1/api.gen.cjs

@@ -371,7 +371,7 @@ class API extends sdkClient.API {
     marshalling_gen.unmarshalCacheStage
   );
   /**
-   * Update cache stage. Update the parameters of an existing cache stage, specified by its `cache_stage_id`. Parameters which can be updated include the `fallback_ttl` and `backend_stage_id`.
+   * Update cache stage. Update the parameters of an existing cache stage, specified by its `cache_stage_id`. Parameters which can be updated include the `fallback_ttl`, `include_cookies` and `backend_stage_id`.
    *
    * @param request - The request {@link UpdateCacheStageRequest}
    * @returns A Promise of CacheStage
@@ -721,6 +721,29 @@ class API extends sdkClient.API {
     },
     marshalling_gen.unmarshalAddRouteRulesResponse
   );
+  /**
+   * List route rules. List all route rules of an organization or project.
+   *
+   * @param request - The request {@link SearchRouteRulesRequest}
+   * @returns A Promise of ListRouteRulesResponse
+   */
+  searchRouteRules = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/edge-services/v1beta1/search-route-rules`,
+      urlParams: sdkClient.urlParams(
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId]
+      )
+    },
+    marshalling_gen.unmarshalListRouteRulesResponse
+  );
   checkDomain = (request) => this.client.fetch(
     {
       body: JSON.stringify(

package/dist/v1beta1/api.gen.d.ts

@@ -1,6 +1,6 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { WaitForOptions } from '@scaleway/sdk-client';
-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';
+import { API as ParentAPI } from '@scaleway/sdk-client';
+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';
 /**
  * Edge Services API.
  */
@@ -170,7 +170,7 @@ export declare class API extends ParentAPI {
      */
     getCacheStage: (request: Readonly<GetCacheStageRequest>) => Promise<CacheStage>;
     /**
-     * Update cache stage. Update the parameters of an existing cache stage, specified by its `cache_stage_id`. Parameters which can be updated include the `fallback_ttl` and `backend_stage_id`.
+     * Update cache stage. Update the parameters of an existing cache stage, specified by its `cache_stage_id`. Parameters which can be updated include the `fallback_ttl`, `include_cookies` and `backend_stage_id`.
      *
      * @param request - The request {@link UpdateCacheStageRequest}
      * @returns A Promise of CacheStage
@@ -319,6 +319,13 @@ export declare class API extends ParentAPI {
      * @returns A Promise of AddRouteRulesResponse
      */
     addRouteRules: (request: Readonly<AddRouteRulesRequest>) => Promise<AddRouteRulesResponse>;
+    /**
+     * List route rules. List all route rules of an organization or project.
+     *
+     * @param request - The request {@link SearchRouteRulesRequest}
+     * @returns A Promise of ListRouteRulesResponse
+     */
+    searchRouteRules: (request?: Readonly<SearchRouteRulesRequest>) => Promise<ListRouteRulesResponse>;
     checkDomain: (request: Readonly<CheckDomainRequest>) => Promise<CheckDomainResponse>;
     checkPEMChain: (request: Readonly<CheckPEMChainRequest>) => Promise<CheckPEMChainResponse>;
     protected pageOfListPurgeRequests: (request?: Readonly<ListPurgeRequestsRequest>) => Promise<ListPurgeRequestsResponse>;

package/dist/v1beta1/api.gen.js

@@ -369,7 +369,7 @@ class API extends API$1 {
     unmarshalCacheStage
   );
   /**
-   * Update cache stage. Update the parameters of an existing cache stage, specified by its `cache_stage_id`. Parameters which can be updated include the `fallback_ttl` and `backend_stage_id`.
+   * Update cache stage. Update the parameters of an existing cache stage, specified by its `cache_stage_id`. Parameters which can be updated include the `fallback_ttl`, `include_cookies` and `backend_stage_id`.
    *
    * @param request - The request {@link UpdateCacheStageRequest}
    * @returns A Promise of CacheStage
@@ -719,6 +719,29 @@ class API extends API$1 {
     },
     unmarshalAddRouteRulesResponse
   );
+  /**
+   * List route rules. List all route rules of an organization or project.
+   *
+   * @param request - The request {@link SearchRouteRulesRequest}
+   * @returns A Promise of ListRouteRulesResponse
+   */
+  searchRouteRules = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/edge-services/v1beta1/search-route-rules`,
+      urlParams: urlParams(
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId]
+      )
+    },
+    unmarshalListRouteRulesResponse
+  );
   checkDomain = (request) => this.client.fetch(
     {
       body: JSON.stringify(

package/dist/v1beta1/index.gen.d.ts

@@ -1,5 +1,5 @@
 export { API } from './api.gen';
 export * from './content.gen';
 export * from './marshalling.gen';
-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';
+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';
 export * as ValidationRules from './validation-rules.gen';

package/dist/v1beta1/marshalling.gen.cjs

@@ -63,6 +63,7 @@ const unmarshalCacheStage = (data) => {
     createdAt: sdkClient.unmarshalDate(data.created_at),
     fallbackTtl: data.fallback_ttl,
     id: data.id,
+    includeCookies: data.include_cookies,
     pipelineId: data.pipeline_id,
     routeStageId: data.route_stage_id,
     updatedAt: sdkClient.unmarshalDate(data.updated_at),
@@ -470,7 +471,8 @@ const unmarshalListRouteRulesResponse = (data) => {
     );
   }
   return {
-    routeRules: sdkClient.unmarshalArrayOfObject(data.route_rules, unmarshalRouteRule)
+    routeRules: sdkClient.unmarshalArrayOfObject(data.route_rules, unmarshalRouteRule),
+    totalCount: data.total_count
   };
 };
 const unmarshalListRouteStagesResponse = (data) => {
@@ -606,6 +608,7 @@ const marshalCreateBackendStageRequest = (request, defaults) => ({
 });
 const marshalCreateCacheStageRequest = (request, defaults) => ({
   fallback_ttl: request.fallbackTtl,
+  include_cookies: request.includeCookies,
   ...sdkClient.resolveOneOf([
     { param: "backend_stage_id", value: request.backendStageId },
     { param: "waf_stage_id", value: request.wafStageId },
@@ -712,6 +715,7 @@ const marshalUpdateBackendStageRequest = (request, defaults) => ({
 });
 const marshalUpdateCacheStageRequest = (request, defaults) => ({
   fallback_ttl: request.fallbackTtl,
+  include_cookies: request.includeCookies,
   ...sdkClient.resolveOneOf([
     { param: "backend_stage_id", value: request.backendStageId },
     { param: "waf_stage_id", value: request.wafStageId },

package/dist/v1beta1/marshalling.gen.js

@@ -61,6 +61,7 @@ const unmarshalCacheStage = (data) => {
     createdAt: unmarshalDate(data.created_at),
     fallbackTtl: data.fallback_ttl,
     id: data.id,
+    includeCookies: data.include_cookies,
     pipelineId: data.pipeline_id,
     routeStageId: data.route_stage_id,
     updatedAt: unmarshalDate(data.updated_at),
@@ -468,7 +469,8 @@ const unmarshalListRouteRulesResponse = (data) => {
     );
   }
   return {
-    routeRules: unmarshalArrayOfObject(data.route_rules, unmarshalRouteRule)
+    routeRules: unmarshalArrayOfObject(data.route_rules, unmarshalRouteRule),
+    totalCount: data.total_count
   };
 };
 const unmarshalListRouteStagesResponse = (data) => {
@@ -604,6 +606,7 @@ const marshalCreateBackendStageRequest = (request, defaults) => ({
 });
 const marshalCreateCacheStageRequest = (request, defaults) => ({
   fallback_ttl: request.fallbackTtl,
+  include_cookies: request.includeCookies,
   ...resolveOneOf([
     { param: "backend_stage_id", value: request.backendStageId },
     { param: "waf_stage_id", value: request.wafStageId },
@@ -710,6 +713,7 @@ const marshalUpdateBackendStageRequest = (request, defaults) => ({
 });
 const marshalUpdateCacheStageRequest = (request, defaults) => ({
   fallback_ttl: request.fallbackTtl,
+  include_cookies: request.includeCookies,
   ...resolveOneOf([
     { param: "backend_stage_id", value: request.backendStageId },
     { param: "waf_stage_id", value: request.wafStageId },

package/dist/v1beta1/types.gen.d.ts

@@ -20,6 +20,7 @@ export type PurgeRequestStatus = 'unknown_status' | 'done' | 'error' | 'pending'
 export type RuleHttpMatchMethodFilter = 'unknown_method_filter' | 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options';
 export type RuleHttpMatchPathFilterPathFilterType = 'unknown_path_filter' | 'regex';
 export type SearchBackendStagesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export type SearchRouteRulesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
 export type SearchWafStagesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
 export type WafStageMode = 'unknown_mode' | 'disable' | 'log_only' | 'enable';
 export interface ScalewayLb {
@@ -144,6 +145,10 @@ export interface CacheStage {
      * Time To Live (TTL) in seconds. Defines how long content is cached.
      */
     fallbackTtl?: string;
+    /**
+     * Defines whether responses to requests with cookies must be stored in the cache.
+     */
+    includeCookies: boolean;
     /**
      * Date the cache stage was created.
      */
@@ -583,6 +588,10 @@ export type CreateCacheStageRequest = {
      * Time To Live (TTL) in seconds. Defines how long content is cached.
      */
     fallbackTtl?: string;
+    /**
+     * Defines whether responses to requests with cookies must be stored in the cache.
+     */
+    includeCookies?: boolean;
     /**
      * Backend stage ID the cache stage will be linked to.
      *
@@ -1114,6 +1123,10 @@ export interface ListRouteRulesResponse {
      * 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`.
      */
     routeRules: RouteRule[];
+    /**
+     * Count of all route rules matching the requested criteria.
+     */
+    totalCount: number;
 }
 export type ListRouteStagesRequest = {
     /**
@@ -1219,6 +1232,13 @@ export type SearchBackendStagesRequest = {
     bucketRegion?: string;
     lbId?: string;
 };
+export type SearchRouteRulesRequest = {
+    orderBy?: SearchRouteRulesRequestOrderBy;
+    page?: number;
+    pageSize?: number;
+    organizationId?: string;
+    projectId?: string;
+};
 export type SearchWafStagesRequest = {
     orderBy?: SearchWafStagesRequestOrderBy;
     page?: number;
@@ -1300,6 +1320,10 @@ export type UpdateCacheStageRequest = {
      * Time To Live (TTL) in seconds. Defines how long content is cached.
      */
     fallbackTtl?: string;
+    /**
+     * Defines whether responses to requests with cookies must be stored in the cache.
+     */
+    includeCookies?: boolean;
     /**
      * Backend stage ID the cache stage will be linked to.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-edge-services",
-  "version": "1.0.5",
+  "version": "1.2.0",
   "description": "Scaleway SDK edge-services",
   "license": "Apache-2.0",
   "files": [
@@ -26,17 +26,17 @@
     "directory": "packages_generated/edge-services"
   },
   "engines": {
-    "node": ">=20.19.1"
+    "node": ">=20.19.4"
   },
   "dependencies": {
-    "@scaleway/random-name": "5.1.1",
-    "@scaleway/sdk-std": "1.0.5"
+    "@scaleway/random-name": "5.1.2",
+    "@scaleway/sdk-std": "1.0.6"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.0"
+    "@scaleway/sdk-client": "^1.3.1"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.0"
+    "@scaleway/sdk-client": "^1.3.1"
   },
   "scripts": {
     "package:check": "pnpm publint",