@papr/memory 1.9.0 → 1.13.0

package/resources/user.mjs

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../core/resource.mjs";
-import { buildHeaders } from "../internal/headers.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class User extends APIResource {
     /**
@@ -10,53 +9,33 @@ export class User extends APIResource {
      * ```ts
      * const userResponse = await client.user.create({
      *   external_id: 'user123',
-     *   'X-API-Key': 'X-API-Key',
      * });
      * ```
      */
-    create(params, options) {
-        const { 'X-API-Key': xAPIKey, ...body } = params;
-        return this._client.post('/v1/user', {
-            body,
-            ...options,
-            headers: buildHeaders([{ 'X-API-Key': xAPIKey }, options?.headers]),
-        });
+    create(body, options) {
+        return this._client.post('/v1/user', { body, ...options });
     }
     /**
      * Update user details by user_id (\_User.objectId) and developer association
      *
      * @example
      * ```ts
-     * const userResponse = await client.user.update('user_id', {
-     *   'X-API-Key': 'X-API-Key',
-     * });
+     * const userResponse = await client.user.update('user_id');
      * ```
      */
-    update(userID, params, options) {
-        const { 'X-API-Key': xAPIKey, ...body } = params;
-        return this._client.put(path `/v1/user/${userID}`, {
-            body,
-            ...options,
-            headers: buildHeaders([{ 'X-API-Key': xAPIKey }, options?.headers]),
-        });
+    update(userID, body, options) {
+        return this._client.put(path `/v1/user/${userID}`, { body, ...options });
     }
     /**
      * List users for a developer
      *
      * @example
      * ```ts
-     * const users = await client.user.list({
-     *   'X-API-Key': 'X-API-Key',
-     * });
+     * const users = await client.user.list();
      * ```
      */
-    list(params, options) {
-        const { 'X-API-Key': xAPIKey, ...query } = params;
-        return this._client.get('/v1/user', {
-            query,
-            ...options,
-            headers: buildHeaders([{ 'X-API-Key': xAPIKey }, options?.headers]),
-        });
+    list(query = {}, options) {
+        return this._client.get('/v1/user', { query, ...options });
     }
     /**
      * Delete user association with developer and the user itself by , assume external
@@ -64,18 +43,12 @@ export class User extends APIResource {
      *
      * @example
      * ```ts
-     * const user = await client.user.delete('user_id', {
-     *   'X-API-Key': 'X-API-Key',
-     * });
+     * const user = await client.user.delete('user_id');
      * ```
      */
-    delete(userID, params, options) {
-        const { 'X-API-Key': xAPIKey, is_external } = params;
-        return this._client.delete(path `/v1/user/${userID}`, {
-            query: { is_external },
-            ...options,
-            headers: buildHeaders([{ 'X-API-Key': xAPIKey }, options?.headers]),
-        });
+    delete(userID, params = {}, options) {
+        const { is_external } = params ?? {};
+        return this._client.delete(path `/v1/user/${userID}`, { query: { is_external }, ...options });
     }
     /**
      * Create multiple users or link existing users to developer, and add each to the
@@ -85,34 +58,22 @@ export class User extends APIResource {
      * ```ts
      * const response = await client.user.createBatch({
      *   users: [{ external_id: 'user123' }],
-     *   'X-API-Key': 'X-API-Key',
      * });
      * ```
      */
-    createBatch(params, options) {
-        const { 'X-API-Key': xAPIKey, ...body } = params;
-        return this._client.post('/v1/user/batch', {
-            body,
-            ...options,
-            headers: buildHeaders([{ 'X-API-Key': xAPIKey }, options?.headers]),
-        });
+    createBatch(body, options) {
+        return this._client.post('/v1/user/batch', { body, ...options });
     }
     /**
      * Get user details by user_id (\_User.objectId) and developer association
      *
      * @example
      * ```ts
-     * const userResponse = await client.user.get('user_id', {
-     *   'X-API-Key': 'X-API-Key',
-     * });
+     * const userResponse = await client.user.get('user_id');
      * ```
      */
-    get(userID, params, options) {
-        const { 'X-API-Key': xAPIKey } = params;
-        return this._client.get(path `/v1/user/${userID}`, {
-            ...options,
-            headers: buildHeaders([{ 'X-API-Key': xAPIKey }, options?.headers]),
-        });
+    get(userID, options) {
+        return this._client.get(path `/v1/user/${userID}`, options);
     }
 }
 //# sourceMappingURL=user.mjs.map

package/resources/user.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"user.mjs","sourceRoot":"","sources":["../src/resources/user.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACpE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,MAAM,EAAE,EAAE;YAChD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACpE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,MAAsB,EAAE,OAAwB;QACnD,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;YAClC,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACpE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,MAAM,EAAE,EAAE;YACnD,KAAK,EAAE,EAAE,WAAW,EAAE;YACtB,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACpE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,MAA6B,EAAE,OAAwB;QACjE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACzC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACpE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,MAAc,EAAE,MAAqB,EAAE,OAAwB;QACjE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,MAAM,EAAE,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACpE,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"user.mjs","sourceRoot":"","sources":["../src/resources/user.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,MAAc,EACd,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,IAA2B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,MAAc,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF"}

package/src/client.ts

@@ -16,6 +16,15 @@ import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
+import {
+  BatchRequest,
+  BatchResponse,
+  Feedback,
+  FeedbackRequest,
+  FeedbackResponse,
+  FeedbackSubmitBatchParams,
+  FeedbackSubmitParams,
+} from './resources/feedback';
 import {
   AddMemory,
   AddMemoryResponse,
@@ -41,7 +50,6 @@ import {
   UserCreateParams,
   UserDeleteParams,
   UserDeleteResponse,
-  UserGetParams,
   UserListParams,
   UserListResponse,
   UserResponse,
@@ -65,7 +73,12 @@ export interface ClientOptions {
   /**
    * Defaults to process.env['PAPR_MEMORY_API_KEY'].
    */
-  apiKey?: string | undefined;
+  xAPIKey?: string | undefined;
+
+  /**
+   * Defaults to process.env['PAPR_MEMORY_Session_Token'].
+   */
+  xSessionToken?: string | null | undefined;
 
   /**
    * Defaults to process.env['PAPR_MEMORY_BEARER_TOKEN'].
@@ -85,6 +98,8 @@ export interface ClientOptions {
    *
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
+   *
+   * @unit milliseconds
    */
   timeout?: number | undefined;
   /**
@@ -143,7 +158,8 @@ export interface ClientOptions {
  * API Client for interfacing with the Papr API.
  */
 export class Papr {
-  apiKey: string;
+  xAPIKey: string;
+  xSessionToken: string | null;
   bearerToken: string | null;
 
   baseURL: string;
@@ -161,7 +177,8 @@ export class Papr {
   /**
    * API Client for interfacing with the Papr API.
    *
-   * @param {string | undefined} [opts.apiKey=process.env['PAPR_MEMORY_API_KEY'] ?? undefined]
+   * @param {string | undefined} [opts.xAPIKey=process.env['PAPR_MEMORY_API_KEY'] ?? undefined]
+   * @param {string | null | undefined} [opts.xSessionToken=process.env['PAPR_MEMORY_Session_Token'] ?? null]
    * @param {string | null | undefined} [opts.bearerToken=process.env['PAPR_MEMORY_BEARER_TOKEN'] ?? null]
    * @param {string} [opts.baseURL=process.env['PAPR_BASE_URL'] ?? https://memory.papr.ai] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
@@ -173,18 +190,20 @@ export class Papr {
    */
   constructor({
     baseURL = readEnv('PAPR_BASE_URL'),
-    apiKey = readEnv('PAPR_MEMORY_API_KEY'),
+    xAPIKey = readEnv('PAPR_MEMORY_API_KEY'),
+    xSessionToken = readEnv('PAPR_MEMORY_Session_Token') ?? null,
     bearerToken = readEnv('PAPR_MEMORY_BEARER_TOKEN') ?? null,
     ...opts
   }: ClientOptions = {}) {
-    if (apiKey === undefined) {
+    if (xAPIKey === undefined) {
       throw new Errors.PaprError(
-        "The PAPR_MEMORY_API_KEY environment variable is missing or empty; either provide it, or instantiate the Papr client with an apiKey option, like new Papr({ apiKey: 'My API Key' }).",
+        "The PAPR_MEMORY_API_KEY environment variable is missing or empty; either provide it, or instantiate the Papr client with an xAPIKey option, like new Papr({ xAPIKey: 'My X API Key' }).",
       );
     }
 
     const options: ClientOptions = {
-      apiKey,
+      xAPIKey,
+      xSessionToken,
       bearerToken,
       ...opts,
       baseURL: baseURL || `https://memory.papr.ai`,
@@ -207,7 +226,8 @@ export class Papr {
 
     this._options = options;
 
-    this.apiKey = apiKey;
+    this.xAPIKey = xAPIKey;
+    this.xSessionToken = xSessionToken;
     this.bearerToken = bearerToken;
   }
 
@@ -215,7 +235,7 @@ export class Papr {
    * Create a new client instance re-using the same options given to the current client with optional overriding.
    */
   withOptions(options: Partial<ClientOptions>): this {
-    return new (this.constructor as any as new (props: ClientOptions) => typeof this)({
+    const client = new (this.constructor as any as new (props: ClientOptions) => typeof this)({
       ...this._options,
       baseURL: this.baseURL,
       maxRetries: this.maxRetries,
@@ -224,10 +244,12 @@ export class Papr {
       logLevel: this.logLevel,
       fetch: this.fetch,
       fetchOptions: this.fetchOptions,
-      apiKey: this.apiKey,
+      xAPIKey: this.xAPIKey,
+      xSessionToken: this.xSessionToken,
       bearerToken: this.bearerToken,
       ...options,
     });
+    return client;
   }
 
   /**
@@ -245,21 +267,32 @@ export class Papr {
     return;
   }
 
-  protected authHeaders(opts: FinalRequestOptions): NullableHeaders | undefined {
-    return buildHeaders([this.apiKeyHeaderAuth(opts), this.bearerAuth(opts)]);
-  }
-
-  protected apiKeyHeaderAuth(opts: FinalRequestOptions): NullableHeaders | undefined {
-    return buildHeaders([{ 'X-Session-Token': this.apiKey }]);
+  protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
+    return buildHeaders([
+      await this.bearerAuth(opts),
+      await this.xSessionTokenAuth(opts),
+      await this.xAPIKeyAuth(opts),
+    ]);
   }
 
-  protected bearerAuth(opts: FinalRequestOptions): NullableHeaders | undefined {
+  protected async bearerAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
     if (this.bearerToken == null) {
       return undefined;
     }
     return buildHeaders([{ Authorization: `Bearer ${this.bearerToken}` }]);
   }
 
+  protected async xSessionTokenAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
+    if (this.xSessionToken == null) {
+      return undefined;
+    }
+    return buildHeaders([{ 'X-Session-Token': this.xSessionToken }]);
+  }
+
+  protected async xAPIKeyAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
+    return buildHeaders([{ 'X-API-Key': this.xAPIKey }]);
+  }
+
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
@@ -388,7 +421,9 @@ export class Papr {
 
     await this.prepareOptions(options);
 
-    const { req, url, timeout } = this.buildRequest(options, { retryCount: maxRetries - retriesRemaining });
+    const { req, url, timeout } = await this.buildRequest(options, {
+      retryCount: maxRetries - retriesRemaining,
+    });
 
     await this.prepareRequest(req, { url, options });
 
@@ -466,7 +501,7 @@ export class Papr {
     } with status ${response.status} in ${headersTime - startTime}ms`;
 
     if (!response.ok) {
-      const shouldRetry = this.shouldRetry(response);
+      const shouldRetry = await this.shouldRetry(response);
       if (retriesRemaining && shouldRetry) {
         const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
 
@@ -565,7 +600,7 @@ export class Papr {
     }
   }
 
-  private shouldRetry(response: Response): boolean {
+  private async shouldRetry(response: Response): Promise<boolean> {
     // Note this is not a standard header.
     const shouldRetryHeader = response.headers.get('x-should-retry');
 
@@ -642,10 +677,10 @@ export class Papr {
     return sleepSeconds * jitter * 1000;
   }
 
-  buildRequest(
+  async buildRequest(
     inputOptions: FinalRequestOptions,
     { retryCount = 0 }: { retryCount?: number } = {},
-  ): { req: FinalizedRequestInit; url: string; timeout: number } {
+  ): Promise<{ req: FinalizedRequestInit; url: string; timeout: number }> {
     const options = { ...inputOptions };
     const { method, path, query, defaultBaseURL } = options;
 
@@ -653,7 +688,7 @@ export class Papr {
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
     options.timeout = options.timeout ?? this.timeout;
     const { bodyHeaders, body } = this.buildBody({ options });
-    const reqHeaders = this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
+    const reqHeaders = await this.buildHeaders({ options: inputOptions, method, bodyHeaders, retryCount });
 
     const req: FinalizedRequestInit = {
       method,
@@ -669,7 +704,7 @@ export class Papr {
     return { req, url, timeout: options.timeout };
   }
 
-  private buildHeaders({
+  private async buildHeaders({
     options,
     method,
     bodyHeaders,
@@ -679,7 +714,7 @@ export class Papr {
     method: HTTPMethod;
     bodyHeaders: HeadersLike;
     retryCount: number;
-  }): Headers {
+  }): Promise<Headers> {
     let idempotencyHeaders: HeadersLike = {};
     if (this.idempotencyHeader && method !== 'get') {
       if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
@@ -695,7 +730,7 @@ export class Papr {
         ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
         ...getPlatformHeaders(),
       },
-      this.authHeaders(options),
+      await this.authHeaders(options),
       this._options.defaultHeaders,
       bodyHeaders,
       options.headers,
@@ -764,9 +799,11 @@ export class Papr {
 
   user: API.User = new API.User(this);
   memory: API.Memory = new API.Memory(this);
+  feedback: API.Feedback = new API.Feedback(this);
 }
 Papr.User = User;
 Papr.Memory = Memory;
+Papr.Feedback = Feedback;
 export declare namespace Papr {
   export type RequestOptions = Opts.RequestOptions;
 
@@ -782,7 +819,6 @@ export declare namespace Papr {
     type UserListParams as UserListParams,
     type UserDeleteParams as UserDeleteParams,
     type UserCreateBatchParams as UserCreateBatchParams,
-    type UserGetParams as UserGetParams,
   };
 
   export {
@@ -803,4 +839,14 @@ export declare namespace Papr {
     type MemoryAddBatchParams as MemoryAddBatchParams,
     type MemorySearchParams as MemorySearchParams,
   };
+
+  export {
+    Feedback as Feedback,
+    type BatchRequest as BatchRequest,
+    type BatchResponse as BatchResponse,
+    type FeedbackRequest as FeedbackRequest,
+    type FeedbackResponse as FeedbackResponse,
+    type FeedbackSubmitParams as FeedbackSubmitParams,
+    type FeedbackSubmitBatchParams as FeedbackSubmitBatchParams,
+  };
 }

package/src/internal/request-options.ts

@@ -9,17 +9,70 @@ import { type HeadersLike } from './headers';
 export type FinalRequestOptions = RequestOptions & { method: HTTPMethod; path: string };
 
 export type RequestOptions = {
+  /**
+   * The HTTP method for the request (e.g., 'get', 'post', 'put', 'delete').
+   */
   method?: HTTPMethod;
+
+  /**
+   * The URL path for the request.
+   *
+   * @example "/v1/foo"
+   */
   path?: string;
+
+  /**
+   * Query parameters to include in the request URL.
+   */
   query?: object | undefined | null;
+
+  /**
+   * The request body. Can be a string, JSON object, FormData, or other supported types.
+   */
   body?: unknown;
+
+  /**
+   * HTTP headers to include with the request. Can be a Headers object, plain object, or array of tuples.
+   */
   headers?: HeadersLike;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
   maxRetries?: number;
+
   stream?: boolean | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * @unit milliseconds
+   */
   timeout?: number;
+
+  /**
+   * Additional `RequestInit` options to be passed to the underlying `fetch` call.
+   * These options will be merged with the client's default fetch options.
+   */
   fetchOptions?: MergedRequestInit;
+
+  /**
+   * An AbortSignal that can be used to cancel the request.
+   */
   signal?: AbortSignal | undefined | null;
+
+  /**
+   * A unique key for this request to enable idempotency.
+   */
   idempotencyKey?: string;
+
+  /**
+   * Override the default base URL for this specific request.
+   */
   defaultBaseURL?: string | undefined;
 
   __binaryResponse?: boolean | undefined;

package/src/internal/uploads.ts

@@ -90,7 +90,7 @@ export const multipartFormRequestOptions = async (
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
 
-const supportsFormDataMap = /** @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
+const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
 
 /**
  * node-fetch doesn't support the global FormData object in recent node versions. Instead of sending

package/src/internal/utils/log.ts

@@ -58,7 +58,7 @@ const noopLogger = {
   debug: noop,
 };
 
-let cachedLoggers = /** @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
+let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
 export function loggerFor(client: Papr): Logger {
   const logger = client.logger;
@@ -106,8 +106,9 @@ export const formatRequestDetails = (details: {
         ([name, value]) => [
           name,
           (
-            name.toLowerCase() === 'x-session-token' ||
             name.toLowerCase() === 'authorization' ||
+            name.toLowerCase() === 'x-session-token' ||
+            name.toLowerCase() === 'x-api-key' ||
             name.toLowerCase() === 'cookie' ||
             name.toLowerCase() === 'set-cookie'
           ) ?

package/src/internal/utils/path.ts

@@ -12,25 +12,43 @@ export function encodeURIPath(str: string) {
   return str.replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/g, encodeURIComponent);
 }
 
+const EMPTY = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.create(null));
+
 export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
   function path(statics: readonly string[], ...params: readonly unknown[]): string {
     // If there are no params, no processing is needed.
     if (statics.length === 1) return statics[0]!;
 
     let postPath = false;
+    const invalidSegments = [];
     const path = statics.reduce((previousValue, currentValue, index) => {
       if (/[?#]/.test(currentValue)) {
         postPath = true;
       }
-      return (
-        previousValue +
-        currentValue +
-        (index === params.length ? '' : (postPath ? encodeURIComponent : pathEncoder)(String(params[index])))
-      );
+      const value = params[index];
+      let encoded = (postPath ? encodeURIComponent : pathEncoder)('' + value);
+      if (
+        index !== params.length &&
+        (value == null ||
+          (typeof value === 'object' &&
+            // handle values from other realms
+            value.toString ===
+              Object.getPrototypeOf(Object.getPrototypeOf((value as any).hasOwnProperty ?? EMPTY) ?? EMPTY)
+                ?.toString))
+      ) {
+        encoded = value + '';
+        invalidSegments.push({
+          start: previousValue.length + currentValue.length,
+          length: encoded.length,
+          error: `Value of type ${Object.prototype.toString
+            .call(value)
+            .slice(8, -1)} is not a valid path parameter`,
+        });
+      }
+      return previousValue + currentValue + (index === params.length ? '' : encoded);
     }, '');
 
     const pathOnly = path.split(/[?#]/, 1)[0]!;
-    const invalidSegments = [];
     const invalidSegmentPattern = /(?<=^|\/)(?:\.|%2e){1,2}(?=\/|$)/gi;
     let match;
 
@@ -39,9 +57,12 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
       invalidSegments.push({
         start: match.index,
         length: match[0].length,
+        error: `Value "${match[0]}" can\'t be safely passed as a path parameter`,
       });
     }
 
+    invalidSegments.sort((a, b) => a.start - b.start);
+
     if (invalidSegments.length > 0) {
       let lastEnd = 0;
       const underline = invalidSegments.reduce((acc, segment) => {
@@ -51,7 +72,11 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
         return acc + spaces + arrows;
       }, '');
 
-      throw new PaprError(`Path parameters result in path with invalid segments:\n${path}\n${underline}`);
+      throw new PaprError(
+        `Path parameters result in path with invalid segments:\n${invalidSegments
+          .map((e) => e.error)
+          .join('\n')}\n${path}\n${underline}`,
+      );
     }
 
     return path;