@scaleway/sdk 1.9.0 → 1.10.0

package/dist/index.d.ts

@@ -57,6 +57,96 @@ type ResourceFetcher<T, R> = (request: R) => Promise<T>;
  */
 declare const waitForResource: <R, T>(stop: WaitForStopCondition<T>, fetcher: ResourceFetcher<T, R>, request: R, options?: WaitForOptions<T> | undefined, strategy?: IntervalStrategy) => Promise<Awaited<T>>;
 
+/**
+ * Defines the interceptor for a `Request`.
+ * This allows you to intercept requests before starting.
+ *
+ * @example
+ * Adds a custom header to a request:
+ * ```
+ * const addCustomHeaderInterceptor
+ *   ({ key, value }: { key: string; value: string }): RequestInterceptor =>
+ *   ({ request }) => {
+ *     const clone = request.clone()
+ *     clone.headers.set(key, value)
+ *
+ *     return clone
+ * }
+ * ```
+ *
+ * @public
+ */
+interface RequestInterceptor {
+    ({ request }: {
+        request: Readonly<Request>;
+    }): Request | Promise<Request>;
+}
+/**
+ * Defines the interceptor for a `Response`.
+ * This allows you to intercept responses before unmarshalling.
+ *
+ * @example
+ * Adds a delay before sending the response:
+ * ```
+ * const addDelayInterceptor: ResponseInterceptor = ({ response }) =>
+ *   new Promise(resolve => {
+ *     setTimeout(() => resolve(response), 1000)
+ *   })
+ * ```
+ *
+ * @public
+ */
+interface ResponseInterceptor {
+    ({ response }: {
+        response: Readonly<Response>;
+    }): Response | Promise<Response>;
+}
+/**
+ * Defines the interceptor for a `Response` error.
+ * This allows you to intercept a response error before exiting the whole process.
+ * You can either rethrow an error, and resolve with a different response.
+ *
+ * @remarks
+ * You must return either:
+ * 1. An error (`throw error` or `Promise.reject(error)`)
+ * 2. Data (directly, or via a Promise)
+ *
+ * @example
+ * Reports error to tracking service:
+ * ```
+ * const reportErrorToTrackingService: ResponseErrorInterceptor = async ({
+ *   request,
+ *   error,
+ * }: {
+ *   request: Request
+ *   error: unknown
+ * }) => {
+ *   await sendErrorToErrorService(request, error)
+ *   throw error
+ * }
+ * ```
+ *
+ * @public
+ */
+interface ResponseErrorInterceptor {
+    ({ request, error }: {
+        request: Request;
+        error: unknown;
+    }): unknown | Promise<unknown>;
+}
+/**
+ * Defines the network interceptors.
+ * Please check the documentation of {@link RequestInterceptor},
+ * {@link ResponseInterceptor} and {@link ResponseErrorInterceptor} for examples.
+ *
+ * @public
+ */
+type NetworkInterceptors = {
+    request?: RequestInterceptor;
+    response?: ResponseInterceptor;
+    responseError?: ResponseErrorInterceptor;
+};
+
 declare enum LevelResolver {
     silent = 0,
     error = 1,
@@ -161,16 +251,6 @@ interface ProfileDefaultValues {
  */
 type Profile = Partial<ProfileDefaultValues & AuthenticationSecrets>;
 
-interface Interceptor<T> {
-    (instance: Readonly<T>): T | Promise<T>;
-}
-
-/** Request Interceptor. */
-type RequestInterceptor = Interceptor<Request>;
-
-/** Response Interceptor. */
-type ResponseInterceptor = Interceptor<Response>;
-
 /**
  * Holds default values of settings.
  *
@@ -198,12 +278,20 @@ interface Settings extends DefaultValues {
     httpClient: typeof fetch;
     /**
      * The Request interceptors.
+     *
+     * @deprecated Please use `interceptors` instead.
      */
-    requestInterceptors: RequestInterceptor[];
+    requestInterceptors?: RequestInterceptor[];
     /**
      * The Response interceptors.
+     *
+     * @deprecated Please use `interceptors` instead.
+     */
+    responseInterceptors?: ResponseInterceptor[];
+    /**
+     * The Network interceptors.
      */
-    responseInterceptors: ResponseInterceptor[];
+    interceptors: NetworkInterceptors[];
     /**
      * The User-Agent sent with each request.
      *
@@ -273,6 +361,49 @@ declare const withUserAgent: (userAgent: string) => (settings: Readonly<Settings
  * @public
  */
 declare const withUserAgentSuffix: (userAgent: string) => (settings: Readonly<Settings>) => Settings;
+/**
+ * Instantiates the SDK with additional interceptors.
+ *
+ * @param interceptors - The additional {@link NetworkInterceptors} interceptors
+ * @returns A factory {@link ClientConfig}
+ *
+ * @remarks
+ * It doesn't override the existing interceptors, but instead push more to the list.
+ * This method should be used in conjunction with the initializer `createAdvancedClient`.
+ *
+ * @example
+ * ```
+ * withAdditionalInterceptors([
+ *   {
+ *     request: ({ request }) => {
+ *       console.log(`Do something with ${JSON.stringify(request)}`)
+ *       return request
+ *     },
+ *     response: ({ response }) => {
+ *       console.log(`Do something with ${JSON.stringify(response)}`)
+ *       return response
+ *     },
+ *     responseError: async ({
+ *       request,
+ *       error,
+ *     }: {
+ *       request: Request
+ *       error: unknown
+ *     }) => {
+ *       console.log(
+ *         `Do something with ${JSON.stringify(request)} and ${JSON.stringify(
+ *           error,
+ *         )}`,
+ *       )
+ *       throw error // or return Promise.resolve(someData)
+ *     },
+ *   },
+ * ])
+ * ```
+ *
+ * @public
+ */
+declare const withAdditionalInterceptors: (interceptors: NetworkInterceptors[]) => (settings: Readonly<Settings>) => Settings;
 
 /** Scaleway Request. */
 type ScwRequest = {
@@ -743,6 +874,17 @@ declare namespace index$t {
   };
 }
 
+/**
+ * Adds asynchronously an header to a request through an interceptor.
+ *
+ * @param key - The header key
+ * @param value - The header value as a Promise
+ * @returns The Request interceptor
+ *
+ * @internal
+ */
+declare const addAsyncHeaderInterceptor: (key: string, getter: () => Promise<string | undefined>) => RequestInterceptor;
+
 /**
  * Abstract class to instantiate API from a {@link Client}.
  *
@@ -762,6 +904,8 @@ interface TokenAccessor {
  * @param getToken - The token accessor
  * @returns The request interceptor
  *
+ * @deprecated Please use addAsyncHeaderInterceptor instead.
+ *
  * @internal
  */
 declare const authenticateWithSessionToken: (getToken: TokenAccessor) => RequestInterceptor;
@@ -26750,7 +26894,7 @@ interface DnsRecord {
     name: string;
     /** Record type. */
     type: DnsRecordType;
-    /** Record time to live. */
+    /** Record time-to-live. */
     ttl: number;
     /** Record value. */
     value: string;
@@ -26770,39 +26914,39 @@ interface DnsRecords {
 }
 /** Hosting. */
 interface Hosting {
-    /** ID of the hosting. */
+    /** ID of the Web Hosting plan. */
     id: string;
-    /** Organization ID of the hosting. */
+    /** ID of the Scaleway Organization the Web Hosting plan belongs to. */
     organizationId: string;
-    /** Project ID of the hosting. */
+    /** ID of the Scaleway Project the Web Hosting plan belongs to. */
     projectId: string;
-    /** Last update date. */
+    /** Date on which the Web Hosting plan was last updated. */
     updatedAt?: Date;
-    /** Creation date. */
+    /** Date on which the Web Hosting plan was created. */
     createdAt?: Date;
-    /** The hosting status. */
+    /** Status of the Web Hosting plan. */
     status: HostingStatus;
     /** Hostname of the host platform. */
     platformHostname: string;
     /** Number of the host platform. */
     platformNumber?: number;
-    /** ID of the active offer. */
+    /** ID of the active offer for the Web Hosting plan. */
     offerId: string;
-    /** Name of the active offer. */
+    /** Name of the active offer for the Web Hosting plan. */
     offerName: string;
-    /** Main domain of the hosting. */
+    /** Main domain associated with the Web Hosting plan. */
     domain: string;
-    /** Tags of the hosting. */
+    /** List of tags associated with the Web Hosting plan. */
     tags: string[];
-    /** Active options of the hosting. */
+    /** Array of any options activated for the Web Hosting plan. */
     options: HostingOption[];
-    /** DNS status of the hosting. */
+    /** DNS status of the Web Hosting plan. */
     dnsStatus: HostingDnsStatus;
-    /** URL to connect to cPanel Dashboard and to Webmail interface. */
+    /** URL to connect to cPanel dashboard and to Webmail interface. */
     cpanelUrls?: HostingCpanelUrls;
-    /** Main hosting cPanel username. */
+    /** Main Web Hosting cPanel username. */
     username: string;
-    /** Region of the hosting. */
+    /** Region where the Web Hosting plan is hosted. */
     region: Region;
 }
 interface HostingCpanelUrls {
@@ -26818,14 +26962,14 @@ interface HostingOption {
 }
 /** List hostings response. */
 interface ListHostingsResponse {
-    /** Number of returned hostings. */
+    /** Number of Web Hosting plans returned. */
     totalCount: number;
-    /** List of hostings. */
+    /** List of Web Hosting plans. */
     hostings: Hosting[];
 }
 /** List offers response. */
 interface ListOffersResponse {
-    /** List of returned offers. */
+    /** List of offers. */
     offers: Offer[];
 }
 /** Nameserver. */
@@ -26834,7 +26978,7 @@ interface Nameserver {
     hostname: string;
     /** Status of the nameserver. */
     status: NameserverStatus;
-    /** If the nameserver is the default. */
+    /** Defines whether the nameserver is the default one. */
     isDefault: boolean;
 }
 /** Offer. */
@@ -26843,13 +26987,16 @@ interface Offer {
     id: string;
     /** Unique identifier used for billing. */
     billingOperationPath: string;
-    /** Offer product. */
+    /** Product constituting this offer. */
     product?: OfferProduct;
-    /** Offer price. */
+    /** Price of this offer. */
     price?: Money;
-    /** If offer is available for a specific hosting. */
+    /**
+     * If a hosting_id was specified in the call, defines whether this offer is
+     * available for that Web Hosting plan to migrate (update) to.
+     */
     available: boolean;
-    /** If not available, return quota warnings. */
+    /** Quota warnings, if the offer is not available for the specified hosting_id. */
     quotaWarnings: OfferQuotaWarning[];
 }
 /** Offer. product. */
@@ -26872,17 +27019,20 @@ type CreateHostingRequest = {
      * config.
      */
     region?: Region;
-    /** ID of the selected offer for the hosting. */
+    /** ID of the selected offer for the Web Hosting plan. */
     offerId: string;
-    /** Project ID of the hosting. */
+    /** ID of the Scaleway Project in which to create the Web Hosting plan. */
     projectId?: string;
-    /** Contact email of the client for the hosting. */
+    /** Contact email for the Web Hosting client. */
     email?: string;
-    /** The tags of the hosting. */
+    /** List of tags for the Web Hosting plan. */
     tags?: string[];
-    /** The domain name of the hosting. */
+    /**
+     * Domain name to link to the Web Hosting plan. You must already own this
+     * domain name, and have completed the DNS validation process beforehand.
+     */
     domain: string;
-    /** IDs of the selected options for the hosting. */
+    /** IDs of any selected additional options for the Web Hosting plan. */
     optionIds?: string[];
 };
 type ListHostingsRequest$1 = {
@@ -26891,24 +27041,42 @@ type ListHostingsRequest$1 = {
      * config.
      */
     region?: Region;
-    /** A positive integer to choose the page to return. */
+    /**
+     * Page number to return, from the paginated results (must be a positive
+     * integer).
+     */
     page?: number;
     /**
-     * A positive integer lower or equal to 100 to select the number of items to
-     * return.
+     * Number of Web Hosting plans to return (must be a positive integer lower or
+     * equal to 100).
      */
     pageSize?: number;
-    /** Define the order of the returned hostings. */
+    /** Sort order for Web Hosting plans in the response. */
     orderBy?: ListHostingsRequestOrderBy;
-    /** Return hostings with these tags. */
+    /**
+     * Tags to filter for, only Web Hosting plans with matching tags will be
+     * returned.
+     */
     tags?: string[];
-    /** Return hostings with these statuses. */
+    /**
+     * Statuses to filter for, only Web Hosting plans with matching statuses will
+     * be returned.
+     */
     statuses?: HostingStatus[];
-    /** Return hostings with this domain. */
+    /**
+     * Domain to filter for, only Web Hosting plans associated with this domain
+     * will be returned.
+     */
     domain?: string;
-    /** Return hostings from this project ID. */
+    /**
+     * Project ID to filter for, only Web Hosting plans from this Project will be
+     * returned.
+     */
     projectId?: string;
-    /** Return hostings from this organization ID. */
+    /**
+     * Organization ID to filter for, only Web Hosting plans from this
+     * Organization will be returned.
+     */
     organizationId?: string;
 };
 type GetHostingRequest = {
@@ -26928,13 +27096,13 @@ type UpdateHostingRequest = {
     region?: Region;
     /** Hosting ID. */
     hostingId: string;
-    /** New contact email for the hosting. */
+    /** New contact email for the Web Hosting plan. */
     email?: string;
-    /** New tags for the hosting. */
+    /** New tags for the Web Hosting plan. */
     tags?: string[];
-    /** New options IDs for the hosting. */
+    /** IDs of the new options for the Web Hosting plan. */
     optionIds?: string[];
-    /** New offer ID for the hosting. */
+    /** ID of the new offer for the Web Hosting plan. */
     offerId?: string;
 };
 type DeleteHostingRequest = {
@@ -26961,7 +27129,7 @@ type GetDomainDnsRecordsRequest = {
      * config.
      */
     region?: Region;
-    /** Domain associated to the DNS records. */
+    /** Domain associated with the DNS records. */
     domain: string;
 };
 type ListOffersRequest = {
@@ -26970,22 +27138,32 @@ type ListOffersRequest = {
      * config.
      */
     region?: Region;
-    /** Define the order of the returned hostings. */
+    /** Sort order of offers in the response. */
     orderBy?: ListOffersRequestOrderBy;
-    /** Select only offers, no options. */
+    /**
+     * Defines whether the response should consist of offers only, without
+     * options.
+     */
     withoutOptions: boolean;
-    /** Select only options. */
+    /**
+     * Defines whether the response should consist of options only, without
+     * offers.
+     */
     onlyOptions: boolean;
-    /** Define a specific hosting id (optional). */
+    /**
+     * ID of a Web Hosting plan, to check compatibility with returned offers (in
+     * case of wanting to update the plan).
+     */
     hostingId?: string;
 };
 
-/** Webhosting API. */
+/** Web Hosting API. */
 declare class API extends API$q {
     /** Lists the available regions of the API. */
     static readonly LOCALITIES: Region[];
     /**
-     * Create a hosting.
+     * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer
+     * type required via the `offer_id` parameter.
      *
      * @param request - The request {@link CreateHostingRequest}
      * @returns A Promise of Hosting
@@ -26993,7 +27171,9 @@ declare class API extends API$q {
     createHosting: (request: Readonly<CreateHostingRequest>) => Promise<Hosting>;
     protected pageOfListHostings: (request?: Readonly<ListHostingsRequest$1>) => Promise<ListHostingsResponse>;
     /**
-     * List all hostings.
+     * List all Web Hosting plans. List all of your existing Web Hosting plans.
+     * Various filters are available to limit the results, including filtering by
+     * domain, status, tag and Project ID.
      *
      * @param request - The request {@link ListHostingsRequest}
      * @returns A Promise of ListHostingsResponse
@@ -27003,7 +27183,8 @@ declare class API extends API$q {
         [Symbol.asyncIterator]: () => AsyncGenerator<Hosting[], void, void>;
     };
     /**
-     * Get a hosting. Get the details of a Hosting with the given ID.
+     * Get a Web Hosting plan. Get the details of one of your existing Web Hosting
+     * plans, specified by its `hosting_id`.
      *
      * @param request - The request {@link GetHostingRequest}
      * @returns A Promise of Hosting
@@ -27018,36 +27199,47 @@ declare class API extends API$q {
      */
     waitForHosting: (request: Readonly<GetHostingRequest>, options?: Readonly<WaitForOptions<Hosting>>) => Promise<Hosting>;
     /**
-     * Update a hosting.
+     * Update a Web Hosting plan. Update the details of one of your existing Web
+     * Hosting plans, specified by its `hosting_id`. You can update parameters
+     * including the contact email address, tags, options and offer.
      *
      * @param request - The request {@link UpdateHostingRequest}
      * @returns A Promise of Hosting
      */
     updateHosting: (request: Readonly<UpdateHostingRequest>) => Promise<Hosting>;
     /**
-     * Delete a hosting. Delete a hosting with the given ID.
+     * Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its
+     * `hosting_id`. Note that deletion is not immediate: it will take place at
+     * the end of the calendar month, after which time your Web Hosting plan and
+     * all its data (files and emails) will be irreversibly lost.
      *
      * @param request - The request {@link DeleteHostingRequest}
      * @returns A Promise of Hosting
      */
     deleteHosting: (request: Readonly<DeleteHostingRequest>) => Promise<Hosting>;
     /**
-     * Restore a hosting. Restore a hosting with the given ID.
+     * Restore a Web Hosting plan. When you [delete a Web Hosting
+     * plan](#path-hostings-delete-a-hosting), definitive deletion does not take
+     * place until the end of the calendar month. In the time between initiating
+     * the deletion, and definitive deletion at the end of the month, you can
+     * choose to **restore** the Web Hosting plan, using this endpoint and
+     * specifying its `hosting_id`.
      *
      * @param request - The request {@link RestoreHostingRequest}
      * @returns A Promise of Hosting
      */
     restoreHosting: (request: Readonly<RestoreHostingRequest>) => Promise<Hosting>;
     /**
-     * Get the DNS records. The set of DNS record of a specific domain associated
-     * to a hosting.
+     * Get DNS records. Get the set of DNS records of a specified domain
+     * associated with a Web Hosting plan.
      *
      * @param request - The request {@link GetDomainDnsRecordsRequest}
      * @returns A Promise of DnsRecords
      */
     getDomainDnsRecords: (request: Readonly<GetDomainDnsRecordsRequest>) => Promise<DnsRecords>;
     /**
-     * List all offers.
+     * List all offers. List the different Web Hosting offers, and their options,
+     * available to order from Scaleway.
      *
      * @param request - The request {@link ListOffersRequest}
      * @returns A Promise of ListOffersResponse
@@ -27145,4 +27337,4 @@ declare namespace index {
   };
 }
 
-export { API$q as API, index$s as Account, index$r as AppleSilicon, index$p as BareMetal, index$o as Billing, Client, ClientConfig, index$n as Cockpit, index$m as Container, DefaultValues, index$l as Domain, index$t as Errors, index$k as FlexibleIP, index$j as Function, index$i as IAM, index$f as IOT, index$g as Instance, index$d as K8S, index$b as LB, Logger, index$9 as MNQ, index$a as Marketplace, Money, Profile, index$8 as RDB, index$7 as Redis, Region, index$6 as Registry, RequestInterceptor, ResponseInterceptor, ScwFile, index$5 as Secret, ServiceInfo, Settings, index$4 as Test, TimeSeries, index$3 as TransactionalEmail, index$2 as VPC, index$1 as VPCGW, WaitForOptions, WaitForStopCondition, index as Webhosting, Zone, authenticateWithSessionToken, createAdvancedClient, createClient, enableConsoleLogger, enrichForPagination, isJSONObject, marshalMoney, marshalScwFile, marshalTimeSeries, resolveOneOf, setLogger, unmarshalArrayOfObject, unmarshalDate, unmarshalMapOfObject, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint, urlParams, validatePathParam, waitForResource, withDefaultPageSize, withHTTPClient, withProfile, withUserAgent, withUserAgentSuffix };
+export { API$q as API, index$s as Account, index$r as AppleSilicon, index$p as BareMetal, index$o as Billing, Client, ClientConfig, index$n as Cockpit, index$m as Container, DefaultValues, index$l as Domain, index$t as Errors, index$k as FlexibleIP, index$j as Function, index$i as IAM, index$f as IOT, index$g as Instance, index$d as K8S, index$b as LB, Logger, index$9 as MNQ, index$a as Marketplace, Money, NetworkInterceptors, Profile, index$8 as RDB, index$7 as Redis, Region, index$6 as Registry, RequestInterceptor, ResponseErrorInterceptor, ResponseInterceptor, ScwFile, index$5 as Secret, ServiceInfo, Settings, index$4 as Test, TimeSeries, index$3 as TransactionalEmail, index$2 as VPC, index$1 as VPCGW, WaitForOptions, WaitForStopCondition, index as Webhosting, Zone, addAsyncHeaderInterceptor, authenticateWithSessionToken, createAdvancedClient, createClient, enableConsoleLogger, enrichForPagination, isJSONObject, marshalMoney, marshalScwFile, marshalTimeSeries, resolveOneOf, setLogger, unmarshalArrayOfObject, unmarshalDate, unmarshalMapOfObject, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint, urlParams, validatePathParam, waitForResource, withAdditionalInterceptors, withDefaultPageSize, withHTTPClient, withProfile, withUserAgent, withUserAgentSuffix };

package/dist/index.js

@@ -1,10 +1,11 @@
 export { enableConsoleLogger, setLogger } from './internal/logger/index.js';
 export { createAdvancedClient, createClient } from './scw/client.js';
-export { withDefaultPageSize, withHTTPClient, withProfile, withUserAgent, withUserAgentSuffix } from './scw/client-ini-factory.js';
+export { withAdditionalInterceptors, withDefaultPageSize, withHTTPClient, withProfile, withUserAgent, withUserAgentSuffix } from './scw/client-ini-factory.js';
 import * as index from './scw/errors/standard/index.js';
 export { index as Errors };
 export { isJSONObject } from './helpers/json.js';
 export { waitForResource } from './internal/async/interval-retrier.js';
+export { addAsyncHeaderInterceptor } from './internal/interceptors/helpers.js';
 export { API } from './scw/api.js';
 export { authenticateWithSessionToken } from './scw/auth.js';
 export { marshalMoney, marshalScwFile, marshalTimeSeries, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint } from './scw/custom-marshalling.js';

package/dist/internal/interceptors/composer.js

@@ -0,0 +1,46 @@
+/**
+ * Composes request interceptors.
+ *
+ * @param interceptors - A list of request interceptors
+ * @returns An async composed interceptor
+ *
+ * @internal
+ */
+const composeRequestInterceptors = interceptors => async request => interceptors.reduce(async (asyncResult, interceptor) => interceptor({
+  request: await asyncResult
+}), Promise.resolve(request));
+
+/**
+ * Composes response interceptors.
+ *
+ * @param interceptors - A list of response interceptors
+ * @returns An async composed interceptor
+ *
+ * @internal
+ */
+const composeResponseInterceptors = interceptors => async response => interceptors.reduce(async (asyncResult, interceptor) => interceptor({
+  response: await asyncResult
+}), Promise.resolve(response));
+
+/**
+ * Compose response error interceptors.
+ *
+ * @internal
+ */
+const composeResponseErrorInterceptors = interceptors => async (request, error) => {
+  let prevError = error;
+  for (const interceptor of interceptors) {
+    try {
+      const res = await interceptor({
+        request,
+        error: prevError
+      });
+      return res;
+    } catch (err) {
+      prevError = err;
+    }
+  }
+  throw prevError;
+};
+
+export { composeRequestInterceptors, composeResponseErrorInterceptors, composeResponseInterceptors };

package/dist/internal/interceptors/{request.js → helpers.js}

@@ -1,5 +1,3 @@
-/** Request Interceptor. */
-
 /**
  * Adds an header to a request through an interceptor.
  *
@@ -9,7 +7,10 @@
  *
  * @internal
  */
-const addHeaderInterceptor = (key, value) => request => {
+const addHeaderInterceptor = (key, value) => _ref => {
+  let {
+    request
+  } = _ref;
   const clone = request.clone();
   if (value !== undefined) {
     clone.headers.append(key, value);

package/dist/scw/auth.js

@@ -1,4 +1,4 @@
-import { addAsyncHeaderInterceptor, addHeaderInterceptor } from '../internal/interceptors/request.js';
+import { addAsyncHeaderInterceptor, addHeaderInterceptor } from '../internal/interceptors/helpers.js';
 import { assertValidAuthenticationSecrets } from './client-ini-profile.js';
 
 const SESSION_HEADER_KEY = 'x-session-token';
@@ -9,6 +9,8 @@ const AUTH_HEADER_KEY = 'x-auth-token';
  * @param getToken - The token accessor
  * @returns The request interceptor
  *
+ * @deprecated Please use addAsyncHeaderInterceptor instead.
+ *
  * @internal
  */
 const authenticateWithSessionToken = getToken => addAsyncHeaderInterceptor(SESSION_HEADER_KEY, getToken);