Merge branch 'main' into v1.5559.0

Author: jremy42

packages/clients/src/api/edge_services/v1alpha1/api.gen.ts

@@ -34,6 +34,7 @@ import {
   unmarshalCheckLbOriginResponse,
   unmarshalCheckPEMChainResponse,
   unmarshalDNSStage,
+  unmarshalGetBillingResponse,
   unmarshalListBackendStagesResponse,
   unmarshalListCacheStagesResponse,
   unmarshalListDNSStagesResponse,
@@ -69,6 +70,8 @@ import type {
   DeletePipelineRequest,
   DeleteTLSStageRequest,
   GetBackendStageRequest,
+  GetBillingRequest,
+  GetBillingResponse,
   GetCacheStageRequest,
   GetCurrentPlanRequest,
   GetDNSStageRequest,
@@ -826,4 +829,20 @@ export class API extends ParentAPI {
       method: 'DELETE',
       path: `/edge-services/v1alpha1/current-plan/${validatePathParam('projectId', request.projectId ?? this.client.settings.defaultProjectId)}`,
     })
+
+  /**
+   * Gives information on current edge-services subscription plan and used
+   * resources with associated price.
+   *
+   * @param request - The request {@link GetBillingRequest}
+   * @returns A Promise of GetBillingResponse
+   */
+  getBilling = (request: Readonly<GetBillingRequest> = {}) =>
+    this.client.fetch<GetBillingResponse>(
+      {
+        method: 'GET',
+        path: `/edge-services/v1alpha1/billing/${validatePathParam('projectId', request.projectId ?? this.client.settings.defaultProjectId)}`,
+      },
+      unmarshalGetBillingResponse,
+    )
 }

packages/clients/src/api/edge_services/v1alpha1/marshalling.gen.ts

@@ -5,6 +5,7 @@ import {
   resolveOneOf,
   unmarshalArrayOfObject,
   unmarshalDate,
+  unmarshalMoney,
 } from '../../../bridge'
 import type { DefaultValues } from '../../../bridge'
 import type {
@@ -24,6 +25,7 @@ import type {
   CreatePurgeRequestRequest,
   CreateTLSStageRequest,
   DNSStage,
+  GetBillingResponse,
   ListBackendStagesResponse,
   ListCacheStagesResponse,
   ListDNSStagesResponse,
@@ -288,6 +290,47 @@ export const unmarshalCheckPEMChainResponse = (
   } as CheckPEMChainResponse
 }
 
+const unmarshalPlanDetails = (data: unknown): PlanDetails => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PlanDetails' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    packageGb: data.package_gb,
+    pipelineLimit: data.pipeline_limit,
+    planName: data.plan_name,
+  } as PlanDetails
+}
+
+export const unmarshalGetBillingResponse = (
+  data: unknown,
+): GetBillingResponse => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'GetBillingResponse' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    currentPlan: data.current_plan
+      ? unmarshalPlanDetails(data.current_plan)
+      : undefined,
+    currentPlanCacheUsage: data.current_plan_cache_usage,
+    extraCacheCost: data.extra_cache_cost
+      ? unmarshalMoney(data.extra_cache_cost)
+      : undefined,
+    extraCacheUsage: data.extra_cache_usage,
+    extraPipelinesCost: data.extra_pipelines_cost
+      ? unmarshalMoney(data.extra_pipelines_cost)
+      : undefined,
+    pipelineNumber: data.pipeline_number,
+    planCost: data.plan_cost ? unmarshalMoney(data.plan_cost) : undefined,
+    totalCost: data.total_cost ? unmarshalMoney(data.total_cost) : undefined,
+  } as GetBillingResponse
+}
+
 export const unmarshalListBackendStagesResponse = (
   data: unknown,
 ): ListBackendStagesResponse => {
@@ -348,20 +391,6 @@ export const unmarshalListPipelinesResponse = (
   } as ListPipelinesResponse
 }
 
-const unmarshalPlanDetails = (data: unknown): PlanDetails => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'PlanDetails' failed as data isn't a dictionary.`,
-    )
-  }
-
-  return {
-    packageGb: data.package_gb,
-    pipelineLimit: data.pipeline_limit,
-    planName: data.plan_name,
-  } as PlanDetails
-}
-
 export const unmarshalListPlansResponse = (
   data: unknown,
 ): ListPlansResponse => {

packages/clients/src/api/edge_services/v1alpha1/types.gen.ts

@@ -1,6 +1,6 @@
 // This file was automatically generated. DO NOT EDIT.
 // If you have any remark or suggestion do not hesitate to open an issue.
-import type { Region, Zone } from '../../../bridge'
+import type { Money, Region, Zone } from '../../../bridge'
 
 export type DNSStageType = 'unknown_type' | 'auto' | 'managed' | 'custom'
 
@@ -279,8 +279,11 @@ export interface CheckPEMChainRequestSecretChain {
 }
 
 export interface PlanDetails {
+  /** Subscription plan name. */
   planName: PlanName
+  /** Amount of egress data from cache included in subscription plan. */
   packageGb: number
+  /** Number of pipeline included in subscription plan. */
   pipelineLimit: number
 }
 
@@ -501,6 +504,32 @@ export type GetBackendStageRequest = {
   backendStageId: string
 }
 
+export type GetBillingRequest = {
+  projectId?: string
+}
+
+export interface GetBillingResponse {
+  /** Information on the current edge-service subscription plan. */
+  currentPlan?: PlanDetails
+  /** Price of the current subscription plan. */
+  planCost?: Money
+  /** Total number of pipeline currently configured. */
+  pipelineNumber: number
+  /** Cost to date of the pipelines not included in the plans. */
+  extraPipelinesCost?: Money
+  /** Total amount of data egressed from cache in current subscription plan. */
+  currentPlanCacheUsage: number
+  /** Total amount of data egressed from cache not included in the plans. */
+  extraCacheUsage: number
+  /** Cost to date of the data egressed from cache not included in the plans. */
+  extraCacheCost?: Money
+  /**
+   * Total cost to date of edge-service product for the month including current
+   * plan, previous plans, extra pipelines and extra egress cache data.
+   */
+  totalCost?: Money
+}
+
 export type GetCacheStageRequest = {
   /** ID of the requested cache stage. */
   cacheStageId: string

packages/clients/src/api/iam/v1alpha1/marshalling.gen.ts

@@ -90,6 +90,7 @@ export const unmarshalAPIKey = (data: unknown): APIKey => {
     description: data.description,
     editable: data.editable,
     expiresAt: unmarshalDate(data.expires_at),
+    managed: data.managed,
     secretKey: data.secret_key,
     updatedAt: unmarshalDate(data.updated_at),
     userId: data.user_id,
@@ -105,9 +106,11 @@ export const unmarshalApplication = (data: unknown): Application => {
 
   return {
     createdAt: unmarshalDate(data.created_at),
+    deletable: data.deletable,
     description: data.description,
     editable: data.editable,
     id: data.id,
+    managed: data.managed,
     name: data.name,
     nbApiKeys: data.nb_api_keys,
     organizationId: data.organization_id,
@@ -126,8 +129,11 @@ export const unmarshalGroup = (data: unknown): Group => {
   return {
     applicationIds: data.application_ids,
     createdAt: unmarshalDate(data.created_at),
+    deletable: data.deletable,
     description: data.description,
+    editable: data.editable,
     id: data.id,
+    managed: data.managed,
     name: data.name,
     organizationId: data.organization_id,
     tags: data.tags,
@@ -166,10 +172,12 @@ export const unmarshalPolicy = (data: unknown): Policy => {
   return {
     applicationId: data.application_id,
     createdAt: unmarshalDate(data.created_at),
+    deletable: data.deletable,
     description: data.description,
     editable: data.editable,
     groupId: data.group_id,
     id: data.id,
+    managed: data.managed,
     name: data.name,
     nbPermissionSets: data.nb_permission_sets,
     nbRules: data.nb_rules,

packages/clients/src/api/iam/v1alpha1/types.gen.ts

@@ -169,6 +169,8 @@ export interface APIKey {
   defaultProjectId: string
   /** Defines whether or not the API key is editable. */
   editable: boolean
+  /** Defines whether or not the API key is managed. */
+  managed: boolean
   /** IP address of the device that created the API key. */
   creationIp: string
 }
@@ -188,6 +190,10 @@ export interface Application {
   organizationId: string
   /** Defines whether or not the application is editable. */
   editable: boolean
+  /** Defines whether or not the application is deletable. */
+  deletable: boolean
+  /** Defines whether or not the application is managed. */
+  managed: boolean
   /** Number of API keys attributed to the application. */
   nbApiKeys: number
   /** Tags associated with the user. */
@@ -213,6 +219,12 @@ export interface Group {
   applicationIds: string[]
   /** Tags associated to the group. */
   tags: string[]
+  /** Defines whether or not the group is editable. */
+  editable: boolean
+  /** Defines whether or not the group is deletable. */
+  deletable: boolean
+  /** Defines whether or not the group is managed. */
+  managed: boolean
 }
 
 export interface Log {
@@ -264,6 +276,10 @@ export interface Policy {
   updatedAt?: Date
   /** Defines whether or not a policy is editable. */
   editable: boolean
+  /** Defines whether or not a policy is deletable. */
+  deletable: boolean
+  /** Defines whether or not a policy is managed. */
+  managed: boolean
   /** Number of rules of the policy. */
   nbRules: number
   /** Number of policy scopes. */