@rippling/rippling-sdk 0.2.0-alpha.100

package/core/error.mjs

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { castToError } from "../internal/errors.mjs";
+export class RipplingSDKError extends Error {
+}
+export class APIError extends RipplingSDKError {
+    constructor(status, error, message, headers) {
+        super(`${APIError.makeMessage(status, error, message)}`);
+        this.status = status;
+        this.headers = headers;
+        this.error = error;
+    }
+    static makeMessage(status, error, message) {
+        const msg = error?.message ?
+            typeof error.message === 'string' ?
+                error.message
+                : JSON.stringify(error.message)
+            : error ? JSON.stringify(error)
+                : message;
+        if (status && msg) {
+            return `${status} ${msg}`;
+        }
+        if (status) {
+            return `${status} status code (no body)`;
+        }
+        if (msg) {
+            return msg;
+        }
+        return '(no status code or body)';
+    }
+    static generate(status, errorResponse, message, headers) {
+        if (!status || !headers) {
+            return new APIConnectionError({ message, cause: castToError(errorResponse) });
+        }
+        const error = errorResponse;
+        if (status === 400) {
+            return new BadRequestError(status, error, message, headers);
+        }
+        if (status === 401) {
+            return new AuthenticationError(status, error, message, headers);
+        }
+        if (status === 403) {
+            return new PermissionDeniedError(status, error, message, headers);
+        }
+        if (status === 404) {
+            return new NotFoundError(status, error, message, headers);
+        }
+        if (status === 409) {
+            return new ConflictError(status, error, message, headers);
+        }
+        if (status === 422) {
+            return new UnprocessableEntityError(status, error, message, headers);
+        }
+        if (status === 429) {
+            return new RateLimitError(status, error, message, headers);
+        }
+        if (status >= 500) {
+            return new InternalServerError(status, error, message, headers);
+        }
+        return new APIError(status, error, message, headers);
+    }
+}
+export class APIUserAbortError extends APIError {
+    constructor({ message } = {}) {
+        super(undefined, undefined, message || 'Request was aborted.', undefined);
+    }
+}
+export class APIConnectionError extends APIError {
+    constructor({ message, cause }) {
+        super(undefined, undefined, message || 'Connection error.', undefined);
+        // in some environments the 'cause' property is already declared
+        // @ts-ignore
+        if (cause)
+            this.cause = cause;
+    }
+}
+export class APIConnectionTimeoutError extends APIConnectionError {
+    constructor({ message } = {}) {
+        super({ message: message ?? 'Request timed out.' });
+    }
+}
+export class BadRequestError extends APIError {
+}
+export class AuthenticationError extends APIError {
+}
+export class PermissionDeniedError extends APIError {
+}
+export class NotFoundError extends APIError {
+}
+export class ConflictError extends APIError {
+}
+export class UnprocessableEntityError extends APIError {
+}
+export class RateLimitError extends APIError {
+}
+export class InternalServerError extends APIError {
+}
+//# sourceMappingURL=error.mjs.map

package/core/error.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.mjs","sourceRoot":"","sources":["../src/core/error.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,+BAA2B;AAEjD,MAAM,OAAO,gBAAiB,SAAQ,KAAK;CAAG;AAE9C,MAAM,OAAO,QAIX,SAAQ,gBAAgB;IAQxB,YAAY,MAAe,EAAE,KAAa,EAAE,OAA2B,EAAE,OAAiB;QACxF,KAAK,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,MAA0B,EAAE,KAAU,EAAE,OAA2B;QAC5F,MAAM,GAAG,GACP,KAAK,EAAE,OAAO,CAAC,CAAC;YACd,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;gBACjC,KAAK,CAAC,OAAO;gBACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC;YACjC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAC/B,CAAC,CAAC,OAAO,CAAC;QAEZ,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;YAClB,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;QAC5B,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,GAAG,MAAM,wBAAwB,CAAC;QAC3C,CAAC;QACD,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,GAAG,CAAC;QACb,CAAC;QACD,OAAO,0BAA0B,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAA0B,EAC1B,aAAiC,EACjC,OAA2B,EAC3B,OAA4B;QAE5B,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO,IAAI,kBAAkB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QAChF,CAAC;QAED,MAAM,KAAK,GAAG,aAAoC,CAAC;QAEnD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,wBAAwB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;YAClB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,QAAyC;IAC9E,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,QAAyC;IAC/E,YAAY,EAAE,OAAO,EAAE,KAAK,EAA+D;QACzF,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACvE,gEAAgE;QAChE,aAAa;QACb,IAAI,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IAChC,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,kBAAkB;IAC/D,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,QAAsB;CAAG;AAE9D,MAAM,OAAO,mBAAoB,SAAQ,QAAsB;CAAG;AAElE,MAAM,OAAO,qBAAsB,SAAQ,QAAsB;CAAG;AAEpE,MAAM,OAAO,aAAc,SAAQ,QAAsB;CAAG;AAE5D,MAAM,OAAO,aAAc,SAAQ,QAAsB;CAAG;AAE5D,MAAM,OAAO,wBAAyB,SAAQ,QAAsB;CAAG;AAEvE,MAAM,OAAO,cAAe,SAAQ,QAAsB;CAAG;AAE7D,MAAM,OAAO,mBAAoB,SAAQ,QAAyB;CAAG"}

package/core/pagination.d.mts

@@ -0,0 +1,50 @@
+import { FinalRequestOptions } from "../internal/request-options.mjs";
+import { type RipplingSDK } from "../client.mjs";
+import { APIPromise } from "./api-promise.mjs";
+import { type APIResponseProps } from "../internal/parse.mjs";
+export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
+export declare abstract class AbstractPage<Item> implements AsyncIterable<Item> {
+    #private;
+    protected options: FinalRequestOptions;
+    protected response: Response;
+    protected body: unknown;
+    constructor(client: RipplingSDK, response: Response, body: unknown, options: FinalRequestOptions);
+    abstract nextPageRequestOptions(): PageRequestOptions | null;
+    abstract getPaginatedItems(): Item[];
+    hasNextPage(): boolean;
+    getNextPage(): Promise<this>;
+    iterPages(): AsyncGenerator<this>;
+    [Symbol.asyncIterator](): AsyncGenerator<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 declare class PagePromise<PageClass extends AbstractPage<Item>, Item = ReturnType<PageClass['getPaginatedItems']>[number]> extends APIPromise<PageClass> implements AsyncIterable<Item> {
+    constructor(client: RipplingSDK, request: Promise<APIResponseProps>, Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass);
+    /**
+     * Allow auto-paginating iteration on an unawaited list call, eg:
+     *
+     *    for await (const item of client.items.list()) {
+     *      console.log(item)
+     *    }
+     */
+    [Symbol.asyncIterator](): AsyncGenerator<Item>;
+}
+export interface PageCursorURLResponse<Item> {
+    results: Array<Item>;
+    next_link: string;
+}
+export declare class PageCursorURL<Item> extends AbstractPage<Item> implements PageCursorURLResponse<Item> {
+    results: Array<Item>;
+    next_link: string;
+    constructor(client: RipplingSDK, response: Response, body: PageCursorURLResponse<Item>, options: FinalRequestOptions);
+    getPaginatedItems(): Item[];
+    nextPageRequestOptions(): PageRequestOptions | null;
+}
+//# sourceMappingURL=pagination.d.mts.map

package/core/pagination.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.d.mts","sourceRoot":"","sources":["../src/core/pagination.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,wCAAoC;AAElE,OAAO,EAAE,KAAK,WAAW,EAAE,sBAAkB;AAC7C,OAAO,EAAE,UAAU,EAAE,0BAAsB;AAC3C,OAAO,EAAE,KAAK,gBAAgB,EAAE,8BAA0B;AAE1D,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC,CAAC;AAE7G,8BAAsB,YAAY,CAAC,IAAI,CAAE,YAAW,aAAa,CAAC,IAAI,CAAC;;IAErE,SAAS,CAAC,OAAO,EAAE,mBAAmB,CAAC;IAEvC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC7B,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC;gBAEZ,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,mBAAmB;IAOhG,QAAQ,CAAC,sBAAsB,IAAI,kBAAkB,GAAG,IAAI;IAE5D,QAAQ,CAAC,iBAAiB,IAAI,IAAI,EAAE;IAEpC,WAAW,IAAI,OAAO;IAMhB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAW3B,SAAS,IAAI,cAAc,CAAC,IAAI,CAAC;IASjC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC;CAOtD;AAED;;;;;;;;GAQG;AACH,qBAAa,WAAW,CACpB,SAAS,SAAS,YAAY,CAAC,IAAI,CAAC,EACpC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC,CAE3D,SAAQ,UAAU,CAAC,SAAS,CAC5B,YAAW,aAAa,CAAC,IAAI,CAAC;gBAG5B,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAClC,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,YAAY,CAAC,KAAK,SAAS;IAU9E;;;;;;OAMG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC;CAMtD;AAED,MAAM,WAAW,qBAAqB,CAAC,IAAI;IACzC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,aAAa,CAAC,IAAI,CAAE,SAAQ,YAAY,CAAC,IAAI,CAAE,YAAW,qBAAqB,CAAC,IAAI,CAAC;IAChG,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;gBAGhB,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,EACjC,OAAO,EAAE,mBAAmB;IAQ9B,iBAAiB,IAAI,IAAI,EAAE;IAI3B,sBAAsB,IAAI,kBAAkB,GAAG,IAAI;CAmBpD"}

package/core/pagination.d.ts

@@ -0,0 +1,50 @@
+import { FinalRequestOptions } from "../internal/request-options.js";
+import { type RipplingSDK } from "../client.js";
+import { APIPromise } from "./api-promise.js";
+import { type APIResponseProps } from "../internal/parse.js";
+export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
+export declare abstract class AbstractPage<Item> implements AsyncIterable<Item> {
+    #private;
+    protected options: FinalRequestOptions;
+    protected response: Response;
+    protected body: unknown;
+    constructor(client: RipplingSDK, response: Response, body: unknown, options: FinalRequestOptions);
+    abstract nextPageRequestOptions(): PageRequestOptions | null;
+    abstract getPaginatedItems(): Item[];
+    hasNextPage(): boolean;
+    getNextPage(): Promise<this>;
+    iterPages(): AsyncGenerator<this>;
+    [Symbol.asyncIterator](): AsyncGenerator<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 declare class PagePromise<PageClass extends AbstractPage<Item>, Item = ReturnType<PageClass['getPaginatedItems']>[number]> extends APIPromise<PageClass> implements AsyncIterable<Item> {
+    constructor(client: RipplingSDK, request: Promise<APIResponseProps>, Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass);
+    /**
+     * Allow auto-paginating iteration on an unawaited list call, eg:
+     *
+     *    for await (const item of client.items.list()) {
+     *      console.log(item)
+     *    }
+     */
+    [Symbol.asyncIterator](): AsyncGenerator<Item>;
+}
+export interface PageCursorURLResponse<Item> {
+    results: Array<Item>;
+    next_link: string;
+}
+export declare class PageCursorURL<Item> extends AbstractPage<Item> implements PageCursorURLResponse<Item> {
+    results: Array<Item>;
+    next_link: string;
+    constructor(client: RipplingSDK, response: Response, body: PageCursorURLResponse<Item>, options: FinalRequestOptions);
+    getPaginatedItems(): Item[];
+    nextPageRequestOptions(): PageRequestOptions | null;
+}
+//# sourceMappingURL=pagination.d.ts.map

package/core/pagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../src/core/pagination.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,uCAAoC;AAElE,OAAO,EAAE,KAAK,WAAW,EAAE,qBAAkB;AAC7C,OAAO,EAAE,UAAU,EAAE,yBAAsB;AAC3C,OAAO,EAAE,KAAK,gBAAgB,EAAE,6BAA0B;AAE1D,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC,CAAC;AAE7G,8BAAsB,YAAY,CAAC,IAAI,CAAE,YAAW,aAAa,CAAC,IAAI,CAAC;;IAErE,SAAS,CAAC,OAAO,EAAE,mBAAmB,CAAC;IAEvC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC7B,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC;gBAEZ,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,mBAAmB;IAOhG,QAAQ,CAAC,sBAAsB,IAAI,kBAAkB,GAAG,IAAI;IAE5D,QAAQ,CAAC,iBAAiB,IAAI,IAAI,EAAE;IAEpC,WAAW,IAAI,OAAO;IAMhB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAW3B,SAAS,IAAI,cAAc,CAAC,IAAI,CAAC;IASjC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC;CAOtD;AAED;;;;;;;;GAQG;AACH,qBAAa,WAAW,CACpB,SAAS,SAAS,YAAY,CAAC,IAAI,CAAC,EACpC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC,CAE3D,SAAQ,UAAU,CAAC,SAAS,CAC5B,YAAW,aAAa,CAAC,IAAI,CAAC;gBAG5B,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAClC,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,YAAY,CAAC,KAAK,SAAS;IAU9E;;;;;;OAMG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC;CAMtD;AAED,MAAM,WAAW,qBAAqB,CAAC,IAAI;IACzC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,aAAa,CAAC,IAAI,CAAE,SAAQ,YAAY,CAAC,IAAI,CAAE,YAAW,qBAAqB,CAAC,IAAI,CAAC;IAChG,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;gBAGhB,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,EACjC,OAAO,EAAE,mBAAmB;IAQ9B,iBAAiB,IAAI,IAAI,EAAE;IAI3B,sBAAsB,IAAI,kBAAkB,GAAG,IAAI;CAmBpD"}

package/core/pagination.js

@@ -0,0 +1,104 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var _AbstractPage_client;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageCursorURL = exports.PagePromise = exports.AbstractPage = void 0;
+const tslib_1 = require("../internal/tslib.js");
+const error_1 = require("./error.js");
+const parse_1 = require("../internal/parse.js");
+const api_promise_1 = require("./api-promise.js");
+class AbstractPage {
+    constructor(client, response, body, options) {
+        _AbstractPage_client.set(this, void 0);
+        tslib_1.__classPrivateFieldSet(this, _AbstractPage_client, client, "f");
+        this.options = options;
+        this.response = response;
+        this.body = body;
+    }
+    hasNextPage() {
+        const items = this.getPaginatedItems();
+        if (!items.length)
+            return false;
+        return this.nextPageRequestOptions() != null;
+    }
+    async getNextPage() {
+        const nextOptions = this.nextPageRequestOptions();
+        if (!nextOptions) {
+            throw new error_1.RipplingSDKError('No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.');
+        }
+        return await tslib_1.__classPrivateFieldGet(this, _AbstractPage_client, "f").requestAPIList(this.constructor, nextOptions);
+    }
+    async *iterPages() {
+        let page = this;
+        yield page;
+        while (page.hasNextPage()) {
+            page = await page.getNextPage();
+            yield page;
+        }
+    }
+    async *[(_AbstractPage_client = new WeakMap(), Symbol.asyncIterator)]() {
+        for await (const page of this.iterPages()) {
+            for (const item of page.getPaginatedItems()) {
+                yield item;
+            }
+        }
+    }
+}
+exports.AbstractPage = AbstractPage;
+/**
+ * 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)
+ *    }
+ */
+class PagePromise extends api_promise_1.APIPromise {
+    constructor(client, request, Page) {
+        super(client, request, async (client, props) => new Page(client, props.response, await (0, parse_1.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]() {
+        const page = await this;
+        for await (const item of page) {
+            yield item;
+        }
+    }
+}
+exports.PagePromise = PagePromise;
+class PageCursorURL extends AbstractPage {
+    constructor(client, response, body, options) {
+        super(client, response, body, options);
+        this.results = body.results || [];
+        this.next_link = body.next_link || '';
+    }
+    getPaginatedItems() {
+        return this.results ?? [];
+    }
+    nextPageRequestOptions() {
+        const urlString = this.next_link;
+        if (!urlString)
+            return null;
+        const url = new URL(urlString);
+        // ensure all of the query params that we used for the last request are also included
+        // in the next request
+        const params = [...Object.entries(this.options.query || {}), ...url.searchParams.entries()];
+        for (const [key, value] of params) {
+            url.searchParams.set(key, value);
+        }
+        return {
+            ...this.options,
+            path: url.toString(),
+            query: undefined,
+        };
+    }
+}
+exports.PageCursorURL = PageCursorURL;
+//# sourceMappingURL=pagination.js.map

package/core/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../src/core/pagination.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;AAEtF,sCAA2C;AAE3C,gDAAyD;AAEzD,kDAA2C;AAK3C,MAAsB,YAAY;IAOhC,YAAY,MAAmB,EAAE,QAAkB,EAAE,IAAa,EAAE,OAA4B;QANhG,uCAAqB;QAOnB,+BAAA,IAAI,wBAAW,MAAM,MAAA,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAMD,WAAW;QACT,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvC,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC,sBAAsB,EAAE,IAAI,IAAI,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,WAAW;QACf,MAAM,WAAW,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAClD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,wBAAgB,CACxB,uFAAuF,CACxF,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,+BAAA,IAAI,4BAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,WAAkB,EAAE,WAAW,CAAC,CAAC;IACjF,CAAC;IAED,KAAK,CAAC,CAAC,SAAS;QACd,IAAI,IAAI,GAAS,IAAI,CAAC;QACtB,MAAM,IAAI,CAAC;QACX,OAAO,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1B,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC;QACb,CAAC;IACH,CAAC;IAED,KAAK,CAAC,CAAC,wCAAC,MAAM,CAAC,aAAa,EAAC;QAC3B,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YAC1C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;gBAC5C,MAAM,IAAI,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAnDD,oCAmDC;AAED;;;;;;;;GAQG;AACH,MAAa,WAIX,SAAQ,wBAAqB;IAG7B,YACE,MAAmB,EACnB,OAAkC,EAClC,IAA4E;QAE5E,KAAK,CACH,MAAM,EACN,OAAO,EACP,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CACtB,IAAI,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,IAAA,4BAAoB,EAAC,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAC7F,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;QACxB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAC;QACb,CAAC;IACH,CAAC;CACF;AAjCD,kCAiCC;AAQD,MAAa,aAAoB,SAAQ,YAAkB;IAKzD,YACE,MAAmB,EACnB,QAAkB,EAClB,IAAiC,EACjC,OAA4B;QAE5B,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAEvC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;IACxC,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED,sBAAsB;QACpB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAE5B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QAE/B,qFAAqF;QACrF,sBAAsB;QACtB,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;QAC5F,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;YAClC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAY,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO;YACL,GAAG,IAAI,CAAC,OAAO;YACf,IAAI,EAAE,GAAG,CAAC,QAAQ,EAAE;YACpB,KAAK,EAAE,SAAS;SACjB,CAAC;IACJ,CAAC;CACF;AAxCD,sCAwCC"}

package/core/pagination.mjs

@@ -0,0 +1,98 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var _AbstractPage_client;
+import { __classPrivateFieldGet, __classPrivateFieldSet } from "../internal/tslib.mjs";
+import { RipplingSDKError } from "./error.mjs";
+import { defaultParseResponse } from "../internal/parse.mjs";
+import { APIPromise } from "./api-promise.mjs";
+export class AbstractPage {
+    constructor(client, response, body, options) {
+        _AbstractPage_client.set(this, void 0);
+        __classPrivateFieldSet(this, _AbstractPage_client, client, "f");
+        this.options = options;
+        this.response = response;
+        this.body = body;
+    }
+    hasNextPage() {
+        const items = this.getPaginatedItems();
+        if (!items.length)
+            return false;
+        return this.nextPageRequestOptions() != null;
+    }
+    async getNextPage() {
+        const nextOptions = this.nextPageRequestOptions();
+        if (!nextOptions) {
+            throw new RipplingSDKError('No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.');
+        }
+        return await __classPrivateFieldGet(this, _AbstractPage_client, "f").requestAPIList(this.constructor, nextOptions);
+    }
+    async *iterPages() {
+        let page = this;
+        yield page;
+        while (page.hasNextPage()) {
+            page = await page.getNextPage();
+            yield page;
+        }
+    }
+    async *[(_AbstractPage_client = new WeakMap(), Symbol.asyncIterator)]() {
+        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 extends APIPromise {
+    constructor(client, request, Page) {
+        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]() {
+        const page = await this;
+        for await (const item of page) {
+            yield item;
+        }
+    }
+}
+export class PageCursorURL extends AbstractPage {
+    constructor(client, response, body, options) {
+        super(client, response, body, options);
+        this.results = body.results || [];
+        this.next_link = body.next_link || '';
+    }
+    getPaginatedItems() {
+        return this.results ?? [];
+    }
+    nextPageRequestOptions() {
+        const urlString = this.next_link;
+        if (!urlString)
+            return null;
+        const url = new URL(urlString);
+        // ensure all of the query params that we used for the last request are also included
+        // in the next request
+        const params = [...Object.entries(this.options.query || {}), ...url.searchParams.entries()];
+        for (const [key, value] of params) {
+            url.searchParams.set(key, value);
+        }
+        return {
+            ...this.options,
+            path: url.toString(),
+            query: undefined,
+        };
+    }
+}
+//# sourceMappingURL=pagination.mjs.map

package/core/pagination.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.mjs","sourceRoot":"","sources":["../src/core/pagination.ts"],"names":[],"mappings":"AAAA,sFAAsF;;;AAEtF,OAAO,EAAE,gBAAgB,EAAE,oBAAgB;AAE3C,OAAO,EAAE,oBAAoB,EAAE,8BAA0B;AAEzD,OAAO,EAAE,UAAU,EAAE,0BAAsB;AAK3C,MAAM,OAAgB,YAAY;IAOhC,YAAY,MAAmB,EAAE,QAAkB,EAAE,IAAa,EAAE,OAA4B;QANhG,uCAAqB;QAOnB,uBAAA,IAAI,wBAAW,MAAM,MAAA,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAMD,WAAW;QACT,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvC,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC,sBAAsB,EAAE,IAAI,IAAI,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,WAAW;QACf,MAAM,WAAW,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAClD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,gBAAgB,CACxB,uFAAuF,CACxF,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,uBAAA,IAAI,4BAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,WAAkB,EAAE,WAAW,CAAC,CAAC;IACjF,CAAC;IAED,KAAK,CAAC,CAAC,SAAS;QACd,IAAI,IAAI,GAAS,IAAI,CAAC;QACtB,MAAM,IAAI,CAAC;QACX,OAAO,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1B,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC;QACb,CAAC;IACH,CAAC;IAED,KAAK,CAAC,CAAC,wCAAC,MAAM,CAAC,aAAa,EAAC;QAC3B,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YAC1C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;gBAC5C,MAAM,IAAI,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,WAIX,SAAQ,UAAqB;IAG7B,YACE,MAAmB,EACnB,OAAkC,EAClC,IAA4E;QAE5E,KAAK,CACH,MAAM,EACN,OAAO,EACP,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CACtB,IAAI,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAC7F,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;QACxB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAC;QACb,CAAC;IACH,CAAC;CACF;AAQD,MAAM,OAAO,aAAoB,SAAQ,YAAkB;IAKzD,YACE,MAAmB,EACnB,QAAkB,EAClB,IAAiC,EACjC,OAA4B;QAE5B,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAEvC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;IACxC,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED,sBAAsB;QACpB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAE5B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QAE/B,qFAAqF;QACrF,sBAAsB;QACtB,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;QAC5F,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;YAClC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAY,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO;YACL,GAAG,IAAI,CAAC,OAAO;YACf,IAAI,EAAE,GAAG,CAAC,QAAQ,EAAE;YACpB,KAAK,EAAE,SAAS;SACjB,CAAC;IACJ,CAAC;CACF"}

package/core/platform/custom-objects/category.d.mts

@@ -0,0 +1,125 @@
+import type { RipplingSDK } from "../../../client.mjs";
+import type { ObjectCategory, ObjectCategoryCreateParams, ObjectCategoryUpdateParams } from "../../../resources/object-categories.mjs";
+import type { CategoryApiName, LogicalCategoryName } from "./types.mjs";
+/**
+ * Author input accepted by {@link defineCustomObjectCategory}.
+ *
+ * @typeParam TName - Logical category name supplied by the caller.
+ */
+interface CustomObjectCategoryDefinitionInput<TName extends string> {
+    /** Logical unsuffixed snake_case category name. */
+    readonly name: LogicalCategoryName<TName>;
+    /** Human-readable display name applied after creation. */
+    readonly displayName: string;
+    /** Optional category description. */
+    readonly description?: string;
+}
+/** Immutable typed category definition used by provisioning and lifecycle helpers. */
+export interface CustomObjectCategoryDefinition<TName extends LogicalCategoryName = LogicalCategoryName> {
+    /** Logical unsuffixed snake_case category name. */
+    readonly name: TName;
+    /** Compiled wire-level category api name. */
+    readonly apiName: CategoryApiName<TName>;
+    /** Human-readable display name. */
+    readonly displayName: string;
+    /** Optional category description. */
+    readonly description?: string;
+}
+/** Result returned by category provisioning helpers. */
+export interface ProvisionedCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
+    /** Source typed category definition. */
+    readonly definition: CustomObjectCategoryDefinition<TName>;
+    /** Response returned by `client.objectCategories.create(...)`. */
+    readonly createdCategory: ObjectCategory;
+    /** Response returned by `client.objectCategories.update(...)`. */
+    readonly updatedCategory: ObjectCategory;
+}
+/** Lifecycle action emitted by category reconciliation helpers. */
+export type CustomObjectCategoryLifecycleAction = 'created' | 'updated' | 'unchanged';
+/** Result returned by category reconciliation helpers. */
+export interface ReconciledCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
+    /** Source typed category definition. */
+    readonly definition: CustomObjectCategoryDefinition<TName>;
+    /** Whether the remote category was created, updated, or already matched. */
+    readonly action: CustomObjectCategoryLifecycleAction;
+    /** Remote category after reconciliation. */
+    readonly category: ObjectCategory;
+}
+/** Options for category provisioning and reconciliation helpers. */
+export interface CustomObjectCategoryMutationOptions {
+    /** Whether to apply the follow-up display-metadata update. Defaults to `true`. */
+    readonly updateDisplayMetadata?: boolean;
+}
+/**
+ * Creates an immutable typed custom-object category definition.
+ *
+ * @param definition - Logical category metadata to normalize and freeze.
+ * @returns Immutable typed category definition with compiled API name.
+ * @typeParam TName - Logical category name supplied by the caller.
+ */
+export declare function defineCustomObjectCategory<TName extends string>(definition: CustomObjectCategoryDefinitionInput<TName>): Readonly<CustomObjectCategoryDefinition<LogicalCategoryName<TName>>>;
+/**
+ * Builds the low-level create payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST create payload using the logical category name.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function buildObjectCategoryCreateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryCreateParams;
+/**
+ * Builds the low-level update payload for an object category.
+ *
+ * @param definition - Typed category definition to compile.
+ * @returns REST update payload using human-facing display metadata.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function buildObjectCategoryUpdateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryUpdateParams;
+/**
+ * Creates one typed custom-object category through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to provision.
+ * @param options - Provisioning behavior flags for display-metadata updates.
+ * @returns Frozen summary of the created and updated backend category DTOs.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function provisionCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ProvisionedCustomObjectCategory<TName>>;
+/**
+ * Creates multiple typed custom-object categories through the REST SDK.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to provision.
+ * @param options - Provisioning behavior flags shared across the batch.
+ * @returns Frozen batch of provisioning results in input order.
+ */
+export declare function provisionCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ProvisionedCustomObjectCategory[]>;
+/**
+ * Reconciles one typed category definition against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition to reconcile.
+ * @param options - Reconciliation behavior flags for display-metadata updates.
+ * @returns Frozen reconciliation result describing the final backend category state.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function reconcileCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ReconciledCustomObjectCategory<TName>>;
+/**
+ * Reconciles multiple typed category definitions against the backend by name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definitions - Typed category definitions to reconcile.
+ * @param options - Reconciliation behavior flags shared across the batch.
+ * @returns Frozen batch of reconciliation results in input order.
+ */
+export declare function reconcileCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ReconciledCustomObjectCategory[]>;
+/**
+ * Deletes a category that matches the typed definition's logical or display name.
+ *
+ * @param client - SDK client used to call the category APIs.
+ * @param definition - Typed category definition used to find the category to delete.
+ * @returns Whether a matching category existed and was deleted.
+ * @typeParam TName - Logical category name carried by the definition.
+ */
+export declare function deleteCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>): Promise<boolean>;
+export {};
+//# sourceMappingURL=category.d.mts.map

package/core/platform/custom-objects/category.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"category.d.mts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/category.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,4BAAwB;AACnD,OAAO,KAAK,EACV,cAAc,EACd,0BAA0B,EAC1B,0BAA0B,EAC3B,iDAA6C;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,oBAAgB;AAIpE;;;;GAIG;AACH,UAAU,mCAAmC,CAAC,KAAK,SAAS,MAAM;IAChE,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC1C,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,sFAAsF;AACtF,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACzC,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,wDAAwD;AACxD,MAAM,WAAW,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACtG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;IACzC,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;CAC1C;AAED,mEAAmE;AACnE,MAAM,MAAM,mCAAmC,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;AAEtF,0DAA0D;AAC1D,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,mCAAmC,CAAC;IACrD,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;CACnC;AAED,oEAAoE;AACpE,MAAM,WAAW,mCAAmC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAC1C;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,SAAS,MAAM,EAC7D,UAAU,EAAE,mCAAmC,CAAC,KAAK,CAAC,GACrD,QAAQ,CAAC,8BAA8B,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAQtE;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AA4DD;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC,CAQjD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,+BAA+B,EAAE,CAAC,CAMrD;AAED;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAyBhD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,8BAA8B,EAAE,CAAC,CAMpD;AAED;;;;;;;GAOG;AACH,wBAAsB,oCAAoC,CAAC,KAAK,SAAS,mBAAmB,EAC1F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,OAAO,CAAC,OAAO,CAAC,CAKlB"}