partnermax 0.2.1 → 0.2.2

package/resources/keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../src/resources/keys.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;OAKG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAI3D;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAYrF;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMlE;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;CACnC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,IAAI;QACnB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,SAAS,EAAE,OAAO,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf,UAAU,EAAE,MAAM,CAAC;QAEnB,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
+{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../src/resources/keys.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;OAKG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAI3D;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAYrF;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMlE;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;CACnC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,IAAI;QACnB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,SAAS,EAAE,OAAO,CAAC;QAEnB,MAAM,EAAE,MAAM,CAAC;QAEf,UAAU,EAAE,MAAM,CAAC;QAEnB,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}

package/resources/keys.js

@@ -6,7 +6,7 @@ const resource_1 = require("../core/resource.js");
 const headers_1 = require("../internal/headers.js");
 const path_1 = require("../internal/utils/path.js");
 /**
- * API key lifecycle management — issue, list, revoke. The partner authenticates every request with `X-Api-Key` (preferred) or `Authorization: Bearer <key>`; the server identifies the partner from the key and scopes all reads/writes to dealers owned by that partner.
+ * API key lifecycle management. PartnerMAX v1 allows one active API key per partner/environment; partners authenticate every request with `X-Api-Key` (preferred) or `Authorization: Bearer <key>`, and replacement is handled through DealerMAX support.
  */
 class Keys extends resource_1.APIResource {
     /**
@@ -19,12 +19,13 @@ class Keys extends resource_1.APIResource {
         return this._client.get('/v1/keys', options);
     }
     /**
-     * Issue a new API key. Plaintext returned exactly once.
+     * Rotate the partner API key during a DealerMAX support flow.
      *
-     * Capability gate: caller's key must hold `can_issue_keys`. The bootstrap key
-     * handed to a partner by DealerMAX support carries this capability; keys minted
-     * here inherit the _same_ capabilities as the caller, so partners can never
-     * accidentally widen their own scope.
+     * Plaintext is returned exactly once. The key authenticating this request is
+     * deactivated in the same transaction that inserts the replacement, preserving
+     * PartnerMAX v1's one-active-key invariant. Callers must not use this endpoint for
+     * per-deployment, CI, or engineer credentials. Capability gate: caller's key must
+     * hold `can_issue_keys`.
      */
     issue(params, options) {
         const { 'Idempotency-Key': idempotencyKey, ...body } = params;

package/resources/keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/resources/keys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;OAKG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAsB,EAAE,OAAwB;QACpD,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACzC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,KAAK,EAAE,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAxCD,oBAwCC"}
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/resources/keys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;OAKG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAsB,EAAE,OAAwB;QACpD,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACzC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,KAAK,EAAE,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAzCD,oBAyCC"}

package/resources/keys.mjs

@@ -3,7 +3,7 @@ import { APIResource } from "../core/resource.mjs";
 import { buildHeaders } from "../internal/headers.mjs";
 import { path } from "../internal/utils/path.mjs";
 /**
- * API key lifecycle management — issue, list, revoke. The partner authenticates every request with `X-Api-Key` (preferred) or `Authorization: Bearer <key>`; the server identifies the partner from the key and scopes all reads/writes to dealers owned by that partner.
+ * API key lifecycle management. PartnerMAX v1 allows one active API key per partner/environment; partners authenticate every request with `X-Api-Key` (preferred) or `Authorization: Bearer <key>`, and replacement is handled through DealerMAX support.
  */
 export class Keys extends APIResource {
     /**
@@ -16,12 +16,13 @@ export class Keys extends APIResource {
         return this._client.get('/v1/keys', options);
     }
     /**
-     * Issue a new API key. Plaintext returned exactly once.
+     * Rotate the partner API key during a DealerMAX support flow.
      *
-     * Capability gate: caller's key must hold `can_issue_keys`. The bootstrap key
-     * handed to a partner by DealerMAX support carries this capability; keys minted
-     * here inherit the _same_ capabilities as the caller, so partners can never
-     * accidentally widen their own scope.
+     * Plaintext is returned exactly once. The key authenticating this request is
+     * deactivated in the same transaction that inserts the replacement, preserving
+     * PartnerMAX v1's one-active-key invariant. Callers must not use this endpoint for
+     * per-deployment, CI, or engineer credentials. Capability gate: caller's key must
+     * hold `can_issue_keys`.
      */
     issue(params, options) {
         const { 'Idempotency-Key': idempotencyKey, ...body } = params;

package/resources/keys.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"keys.mjs","sourceRoot":"","sources":["../src/resources/keys.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;OAKG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAsB,EAAE,OAAwB;QACpD,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACzC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,KAAK,EAAE,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"keys.mjs","sourceRoot":"","sources":["../src/resources/keys.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;OAKG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAsB,EAAE,OAAwB;QACpD,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACzC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,KAAK,EAAE,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/client.ts

@@ -14,15 +14,16 @@ import * as Opts from './internal/request-options';
 import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
+import * as Pagination from './core/pagination';
+import { AbstractPage, type CursorPageParams, CursorPageResponse } from './core/pagination';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
 import { KeyIssueParams, KeyIssueResponse, KeyListResponse, Keys } from './resources/keys';
 import {
-  DealerCreateParams,
   DealerDetail,
   DealerListParams,
-  DealerListResponse,
+  DealerSummariesCursorPage,
   DealerSummary,
   DealerUpdateParams,
   Dealers,
@@ -551,6 +552,30 @@ export class Partnermax {
     return { response, options, controller, requestLogID, retryOfRequestLogID, startTime };
   }
 
+  getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
+    path: string,
+    Page: new (...args: any[]) => PageClass,
+    opts?: PromiseOrValue<RequestOptions>,
+  ): Pagination.PagePromise<PageClass, Item> {
+    return this.requestAPIList(
+      Page,
+      opts && 'then' in opts ?
+        opts.then((opts) => ({ method: 'get', path, ...opts }))
+      : { method: 'get', path, ...opts },
+    );
+  }
+
+  requestAPIList<
+    Item = unknown,
+    PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
+  >(
+    Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
+    options: PromiseOrValue<FinalRequestOptions>,
+  ): Pagination.PagePromise<PageClass, Item> {
+    const request = this.makeRequest(options, null, undefined);
+    return new Pagination.PagePromise<PageClass, Item>(this as any as Partnermax, request, Page);
+  }
+
   async fetchWithTimeout(
     url: RequestInfo,
     init: RequestInit | undefined,
@@ -807,7 +832,7 @@ export class Partnermax {
   static toFile = Uploads.toFile;
 
   /**
-   * API key lifecycle management — issue, list, revoke. The partner authenticates every request with `X-Api-Key` (preferred) or `Authorization: Bearer <key>`; the server identifies the partner from the key and scopes all reads/writes to dealers owned by that partner.
+   * API key lifecycle management. PartnerMAX v1 allows one active API key per partner/environment; partners authenticate every request with `X-Api-Key` (preferred) or `Authorization: Bearer <key>`, and replacement is handled through DealerMAX support.
    */
   keys: API.Keys = new API.Keys(this);
   /**
@@ -822,6 +847,9 @@ Partnermax.Dealers = Dealers;
 export declare namespace Partnermax {
   export type RequestOptions = Opts.RequestOptions;
 
+  export import CursorPage = Pagination.CursorPage;
+  export { type CursorPageParams as CursorPageParams, type CursorPageResponse as CursorPageResponse };
+
   export {
     Keys as Keys,
     type KeyListResponse as KeyListResponse,
@@ -833,8 +861,7 @@ export declare namespace Partnermax {
     Dealers as Dealers,
     type DealerDetail as DealerDetail,
     type DealerSummary as DealerSummary,
-    type DealerListResponse as DealerListResponse,
-    type DealerCreateParams as DealerCreateParams,
+    type DealerSummariesCursorPage as DealerSummariesCursorPage,
     type DealerUpdateParams as DealerUpdateParams,
     type DealerListParams as DealerListParams,
   };

package/src/core/pagination.ts

@@ -0,0 +1,170 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { PartnermaxError } from './error';
+import { FinalRequestOptions } from '../internal/request-options';
+import { defaultParseResponse } from '../internal/parse';
+import { type Partnermax } from '../client';
+import { APIPromise } from './api-promise';
+import { type APIResponseProps } from '../internal/parse';
+import { maybeObj } from '../internal/utils/values';
+
+export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
+
+export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
+  #client: Partnermax;
+  protected options: FinalRequestOptions;
+
+  protected response: Response;
+  protected body: unknown;
+
+  constructor(client: Partnermax, response: Response, body: unknown, options: FinalRequestOptions) {
+    this.#client = client;
+    this.options = options;
+    this.response = response;
+    this.body = body;
+  }
+
+  abstract nextPageRequestOptions(): PageRequestOptions | null;
+
+  abstract getPaginatedItems(): Item[];
+
+  hasNextPage(): boolean {
+    const items = this.getPaginatedItems();
+    if (!items.length) return false;
+    return this.nextPageRequestOptions() != null;
+  }
+
+  async getNextPage(): Promise<this> {
+    const nextOptions = this.nextPageRequestOptions();
+    if (!nextOptions) {
+      throw new PartnermaxError(
+        'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.',
+      );
+    }
+
+    return await this.#client.requestAPIList(this.constructor as any, nextOptions);
+  }
+
+  async *iterPages(): AsyncGenerator<this> {
+    let page: this = this;
+    yield page;
+    while (page.hasNextPage()) {
+      page = await page.getNextPage();
+      yield page;
+    }
+  }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    for await (const page of this.iterPages()) {
+      for (const item of page.getPaginatedItems()) {
+        yield item;
+      }
+    }
+  }
+}
+
+/**
+ * This subclass of Promise will resolve to an instantiated Page once the request completes.
+ *
+ * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:
+ *
+ *    for await (const item of client.items.list()) {
+ *      console.log(item)
+ *    }
+ */
+export class PagePromise<
+    PageClass extends AbstractPage<Item>,
+    Item = ReturnType<PageClass['getPaginatedItems']>[number],
+  >
+  extends APIPromise<PageClass>
+  implements AsyncIterable<Item>
+{
+  constructor(
+    client: Partnermax,
+    request: Promise<APIResponseProps>,
+    Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass,
+  ) {
+    super(
+      client,
+      request,
+      async (client, props) =>
+        new Page(client, props.response, await defaultParseResponse(client, props), props.options),
+    );
+  }
+
+  /**
+   * Allow auto-paginating iteration on an unawaited list call, eg:
+   *
+   *    for await (const item of client.items.list()) {
+   *      console.log(item)
+   *    }
+   */
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    const page = await this;
+    for await (const item of page) {
+      yield item;
+    }
+  }
+}
+
+export interface CursorPageResponse<Item> {
+  data: Array<Item>;
+
+  has_more: boolean;
+
+  next_cursor: string | null;
+}
+
+export interface CursorPageParams {
+  cursor?: string | null;
+
+  limit?: number;
+}
+
+export class CursorPage<Item> extends AbstractPage<Item> implements CursorPageResponse<Item> {
+  data: Array<Item>;
+
+  has_more: boolean;
+
+  next_cursor: string | null;
+
+  constructor(
+    client: Partnermax,
+    response: Response,
+    body: CursorPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.data = body.data || [];
+    this.has_more = body.has_more || false;
+    this.next_cursor = body.next_cursor || null;
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const cursor = this.next_cursor;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        cursor,
+      },
+    };
+  }
+}

package/src/index.ts

@@ -5,6 +5,7 @@ export { Partnermax as default } from './client';
 export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
 export { Partnermax, type ClientOptions } from './client';
+export { PagePromise } from './core/pagination';
 export {
   PartnermaxError,
   APIError,

package/src/pagination.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/pagination instead */
+export * from './core/pagination';

package/src/resources/dealers/dealers.ts

@@ -17,11 +17,13 @@ import {
   VehicleList,
   VehicleListParams,
   VehicleRetrieveParams,
+  VehicleSummariesCursorPage,
   VehicleSummary,
   VehicleUpdateParams,
   Vehicles,
 } from './vehicles/vehicles';
 import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -34,21 +36,6 @@ export class Dealers extends APIResource {
   nlt: NltAPI.Nlt = new NltAPI.Nlt(this._client);
   vehicles: VehiclesAPI.Vehicles = new VehiclesAPI.Vehicles(this._client);
 
-  /**
-   * Provision a new dealer as child of the calling partner.
-   */
-  create(params: DealerCreateParams, options?: RequestOptions): APIPromise<DealerDetail> {
-    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
-    return this._client.post('/v1/dealers', {
-      body,
-      ...options,
-      headers: buildHeaders([
-        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Fetch a dealer's full detail. ACL-protected.
    */
@@ -77,8 +64,8 @@ export class Dealers extends APIResource {
   list(
     query: DealerListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<DealerListResponse> {
-    return this._client.get('/v1/dealers', { query, ...options });
+  ): PagePromise<DealerSummariesCursorPage, DealerSummary> {
+    return this._client.getAPIList('/v1/dealers', CursorPage<DealerSummary>, { query, ...options });
   }
 
   /**
@@ -92,6 +79,8 @@ export class Dealers extends APIResource {
   }
 }
 
+export type DealerSummariesCursorPage = CursorPage<DealerSummary>;
+
 /**
  * Full dealer payload used by single-resource and write endpoints.
  */
@@ -176,79 +165,6 @@ export interface DealerSummary {
   last_active_at?: string | null;
 }
 
-/**
- * Response envelope for `GET /v1/dealers`.
- */
-export interface DealerListResponse {
-  data: Array<DealerSummary>;
-
-  has_more: boolean;
-
-  next_cursor?: string | null;
-}
-
-export interface DealerCreateParams {
-  /**
-   * Body param
-   */
-  address: string;
-
-  /**
-   * Body param
-   */
-  business_name: string;
-
-  /**
-   * Body param
-   */
-  city: string;
-
-  /**
-   * Body param
-   */
-  contact_email: string;
-
-  /**
-   * Body param
-   */
-  contact_phone: string;
-
-  /**
-   * Body param
-   */
-  postal_code: string;
-
-  /**
-   * Body param
-   */
-  primary_domain: string;
-
-  /**
-   * Body param
-   */
-  province_code: string;
-
-  /**
-   * Body param
-   */
-  vat_number: string;
-
-  /**
-   * Body param
-   */
-  activate?: boolean;
-
-  /**
-   * Body param
-   */
-  metadata?: { [key: string]: string };
-
-  /**
-   * Header param
-   */
-  'Idempotency-Key'?: string;
-}
-
 export interface DealerUpdateParams {
   /**
    * Body param
@@ -301,11 +217,7 @@ export interface DealerUpdateParams {
   'Idempotency-Key'?: string;
 }
 
-export interface DealerListParams {
-  cursor?: string | null;
-
-  limit?: number;
-
+export interface DealerListParams extends CursorPageParams {
   status?: 'active' | 'inactive' | 'all';
 }
 
@@ -316,8 +228,7 @@ export declare namespace Dealers {
   export {
     type DealerDetail as DealerDetail,
     type DealerSummary as DealerSummary,
-    type DealerListResponse as DealerListResponse,
-    type DealerCreateParams as DealerCreateParams,
+    type DealerSummariesCursorPage as DealerSummariesCursorPage,
     type DealerUpdateParams as DealerUpdateParams,
     type DealerListParams as DealerListParams,
   };
@@ -338,6 +249,7 @@ export declare namespace Dealers {
     type VehicleDetail as VehicleDetail,
     type VehicleList as VehicleList,
     type VehicleSummary as VehicleSummary,
+    type VehicleSummariesCursorPage as VehicleSummariesCursorPage,
     type VehicleCreateParams as VehicleCreateParams,
     type VehicleRetrieveParams as VehicleRetrieveParams,
     type VehicleUpdateParams as VehicleUpdateParams,

package/src/resources/dealers/index.ts

@@ -4,10 +4,9 @@ export {
   Dealers,
   type DealerDetail,
   type DealerSummary,
-  type DealerListResponse,
-  type DealerCreateParams,
   type DealerUpdateParams,
   type DealerListParams,
+  type DealerSummariesCursorPage,
 } from './dealers';
 export { Nlt } from './nlt/index';
 export { NltSettings, type DownPaymentTiers, type NltSettingUpdateParams } from './nlt-settings';
@@ -25,4 +24,5 @@ export {
   type VehicleListParams,
   type VehicleDeleteParams,
   type VehicleBulkParams,
+  type VehicleSummariesCursorPage,
 } from './vehicles/index';

package/src/resources/dealers/nlt/index.ts

@@ -5,7 +5,7 @@ export {
   Offers,
   type NltOfferSummary,
   type OfferRetrieveResponse,
-  type OfferListResponse,
   type OfferRetrieveParams,
   type OfferListParams,
+  type NltOfferSummariesCursorPage,
 } from './offers';

package/src/resources/dealers/nlt/nlt.ts

@@ -3,9 +3,9 @@
 import { APIResource } from '../../../core/resource';
 import * as OffersAPI from './offers';
 import {
+  NltOfferSummariesCursorPage,
   NltOfferSummary,
   OfferListParams,
-  OfferListResponse,
   OfferRetrieveParams,
   OfferRetrieveResponse,
   Offers,
@@ -22,7 +22,7 @@ export declare namespace Nlt {
     Offers as Offers,
     type NltOfferSummary as NltOfferSummary,
     type OfferRetrieveResponse as OfferRetrieveResponse,
-    type OfferListResponse as OfferListResponse,
+    type NltOfferSummariesCursorPage as NltOfferSummariesCursorPage,
     type OfferRetrieveParams as OfferRetrieveParams,
     type OfferListParams as OfferListParams,
   };