@rippling/rippling-sdk 0.2.0-alpha.108 → 0.2.0-alpha.109

package/src/resources/spend-categories.ts

@@ -0,0 +1,175 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class SpendCategories extends APIResource {
+  /**
+   * A list of spend categories.
+   *
+   * - Requires: `Internal Testing`
+   * - Filterable fields: `name`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /spend-categories/?filter=filter&order_by=order_by&limit=50&cursor=cursor HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {
+   *         "name": "date_of_birth",
+   *         "reason": "Insufficient entitlements"
+   *       }
+   *     ]
+   *   },
+   *   "results": [
+   *     {
+   *       "id": "string",
+   *       "created_at": "string",
+   *       "updated_at": "string",
+   *       "name": "string",
+   *       "active": false
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
+   */
+  list(
+    query: SpendCategoryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SpendCategoryListResponsesPageCursorURL, SpendCategoryListResponse> {
+    return this._client.getAPIList('/spend-categories/', PageCursorURL<SpendCategoryListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific spend category
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /spend-categories/{id}/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {}
+   *     ]
+   *   }
+   * }
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SpendCategoryRetrieveResponse> {
+    return this._client.get(path`/spend-categories/${id}/`, options);
+  }
+}
+
+export type SpendCategoryListResponsesPageCursorURL = PageCursorURL<SpendCategoryListResponse>;
+
+/**
+ * A Spend category used to classify transaction line items.
+ *
+ *     Inactive categories are included so historical transactions can still resolve their category.
+ */
+export interface SpendCategoryListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether the category is active. Inactive categories remain available for
+   * historical references.
+   */
+  active?: boolean;
+
+  /**
+   * Name of the Spend category.
+   */
+  name?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface SpendCategoryRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether the category is active. Inactive categories remain available for
+   * historical references.
+   */
+  active?: boolean;
+
+  /**
+   * Name of the Spend category.
+   */
+  name?: string;
+}
+
+export interface SpendCategoryListParams {
+  cursor?: string;
+
+  filter?: string;
+
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
+  order_by?: string;
+}
+
+export declare namespace SpendCategories {
+  export {
+    type SpendCategoryListResponse as SpendCategoryListResponse,
+    type SpendCategoryRetrieveResponse as SpendCategoryRetrieveResponse,
+    type SpendCategoryListResponsesPageCursorURL as SpendCategoryListResponsesPageCursorURL,
+    type SpendCategoryListParams as SpendCategoryListParams,
+  };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.108'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.109'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.108";
+export declare const VERSION = "0.2.0-alpha.109";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.108";
+export declare const VERSION = "0.2.0-alpha.109";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.108'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.109'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.108'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.109'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/lib/charts/guards.d.mts

@@ -1,15 +0,0 @@
-import { type RuleNode, type Scalar } from "./types.mjs";
-/**
- * Assert `node` is shaped like a rule node — an object carrying a string `kind`.
- * An unrecognised `kind` is *not* rejected here; that is the caller's `switch`
- * default (`UnknownNodeError`), the deliberate "configured in code" signal.
- */
-export declare function assertRuleNode(node: unknown): asserts node is RuleNode;
-/**
- * Read a `literal` node's `value`, rejecting a missing or non-scalar one. Without
- * this, `{ kind: 'literal' }` resolves to `undefined` and slips past the caller.
- */
-export declare function literalValue(node: {
-    value?: unknown;
-}): Scalar;
-//# sourceMappingURL=guards.d.mts.map

package/lib/charts/guards.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"guards.d.mts","sourceRoot":"","sources":["../../src/lib/charts/guards.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAE,oBAAgB;AAYrD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,IAAI,QAAQ,CAStE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAQ9D"}

package/lib/charts/guards.d.ts

@@ -1,15 +0,0 @@
-import { type RuleNode, type Scalar } from "./types.js";
-/**
- * Assert `node` is shaped like a rule node — an object carrying a string `kind`.
- * An unrecognised `kind` is *not* rejected here; that is the caller's `switch`
- * default (`UnknownNodeError`), the deliberate "configured in code" signal.
- */
-export declare function assertRuleNode(node: unknown): asserts node is RuleNode;
-/**
- * Read a `literal` node's `value`, rejecting a missing or non-scalar one. Without
- * this, `{ kind: 'literal' }` resolves to `undefined` and slips past the caller.
- */
-export declare function literalValue(node: {
-    value?: unknown;
-}): Scalar;
-//# sourceMappingURL=guards.d.ts.map

package/lib/charts/guards.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../src/lib/charts/guards.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAE,mBAAgB;AAYrD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,IAAI,QAAQ,CAStE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAQ9D"}

package/lib/charts/guards.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertRuleNode = assertRuleNode;
-exports.literalValue = literalValue;
-const errors_1 = require("./errors.js");
-/**
- * Runtime validation for one node of a deserialized, untrusted rule tree, shared
- * by `evaluate` and `describe`. A rule can arrive from JSON that TypeScript never
- * checked, so `null`, a non-object, or a node without a string `kind` would throw
- * a native `TypeError` on the first field read — skipping the `ChartRuleError`
- * escape hatch a caller relies on. Validate before reading fields.
- */
-const SCALAR_TYPES = new Set(['number', 'string', 'boolean']);
-/**
- * Assert `node` is shaped like a rule node — an object carrying a string `kind`.
- * An unrecognised `kind` is *not* rejected here; that is the caller's `switch`
- * default (`UnknownNodeError`), the deliberate "configured in code" signal.
- */
-function assertRuleNode(node) {
-    if (node === null ||
-        typeof node !== 'object' ||
-        Array.isArray(node) ||
-        typeof node.kind !== 'string') {
-        throw new errors_1.MalformedRuleError('a rule node must be an object with a string "kind"');
-    }
-}
-/**
- * Read a `literal` node's `value`, rejecting a missing or non-scalar one. Without
- * this, `{ kind: 'literal' }` resolves to `undefined` and slips past the caller.
- */
-function literalValue(node) {
-    const { value } = node;
-    if (value === null || SCALAR_TYPES.has(typeof value)) {
-        return value;
-    }
-    throw new errors_1.MalformedRuleError(`a literal must carry a scalar value, got ${value === undefined ? 'undefined' : typeof value}`);
-}
-//# sourceMappingURL=guards.js.map

package/lib/charts/guards.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/lib/charts/guards.ts"],"names":[],"mappings":";;AAkBA,wCASC;AAMD,oCAQC;AAzCD,wCAA8C;AAG9C;;;;;;GAMG;AAEH,MAAM,YAAY,GAAwB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AAEnF;;;;GAIG;AACH,SAAgB,cAAc,CAAC,IAAa;IAC1C,IACE,IAAI,KAAK,IAAI;QACb,OAAO,IAAI,KAAK,QAAQ;QACxB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACnB,OAAQ,IAA2B,CAAC,IAAI,KAAK,QAAQ,EACrD,CAAC;QACD,MAAM,IAAI,2BAAkB,CAAC,oDAAoD,CAAC,CAAC;IACrF,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,YAAY,CAAC,IAAyB;IACpD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACvB,IAAI,KAAK,KAAK,IAAI,IAAI,YAAY,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QACrD,OAAO,KAAe,CAAC;IACzB,CAAC;IACD,MAAM,IAAI,2BAAkB,CAC1B,4CAA4C,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,KAAK,EAAE,CAC/F,CAAC;AACJ,CAAC"}

package/lib/charts/guards.mjs

@@ -1,34 +0,0 @@
-import { MalformedRuleError } from "./errors.mjs";
-/**
- * Runtime validation for one node of a deserialized, untrusted rule tree, shared
- * by `evaluate` and `describe`. A rule can arrive from JSON that TypeScript never
- * checked, so `null`, a non-object, or a node without a string `kind` would throw
- * a native `TypeError` on the first field read — skipping the `ChartRuleError`
- * escape hatch a caller relies on. Validate before reading fields.
- */
-const SCALAR_TYPES = new Set(['number', 'string', 'boolean']);
-/**
- * Assert `node` is shaped like a rule node — an object carrying a string `kind`.
- * An unrecognised `kind` is *not* rejected here; that is the caller's `switch`
- * default (`UnknownNodeError`), the deliberate "configured in code" signal.
- */
-export function assertRuleNode(node) {
-    if (node === null ||
-        typeof node !== 'object' ||
-        Array.isArray(node) ||
-        typeof node.kind !== 'string') {
-        throw new MalformedRuleError('a rule node must be an object with a string "kind"');
-    }
-}
-/**
- * Read a `literal` node's `value`, rejecting a missing or non-scalar one. Without
- * this, `{ kind: 'literal' }` resolves to `undefined` and slips past the caller.
- */
-export function literalValue(node) {
-    const { value } = node;
-    if (value === null || SCALAR_TYPES.has(typeof value)) {
-        return value;
-    }
-    throw new MalformedRuleError(`a literal must carry a scalar value, got ${value === undefined ? 'undefined' : typeof value}`);
-}
-//# sourceMappingURL=guards.mjs.map

package/lib/charts/guards.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"guards.mjs","sourceRoot":"","sources":["../../src/lib/charts/guards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,qBAAiB;AAG9C;;;;;;GAMG;AAEH,MAAM,YAAY,GAAwB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AAEnF;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,IAAa;IAC1C,IACE,IAAI,KAAK,IAAI;QACb,OAAO,IAAI,KAAK,QAAQ;QACxB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACnB,OAAQ,IAA2B,CAAC,IAAI,KAAK,QAAQ,EACrD,CAAC;QACD,MAAM,IAAI,kBAAkB,CAAC,oDAAoD,CAAC,CAAC;IACrF,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,IAAyB;IACpD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACvB,IAAI,KAAK,KAAK,IAAI,IAAI,YAAY,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QACrD,OAAO,KAAe,CAAC;IACzB,CAAC;IACD,MAAM,IAAI,kBAAkB,CAC1B,4CAA4C,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,KAAK,EAAE,CAC/F,CAAC;AACJ,CAAC"}

package/src/lib/charts/guards.ts

@@ -1,42 +0,0 @@
-import { MalformedRuleError } from './errors';
-import { type RuleNode, type Scalar } from './types';
-
-/**
- * Runtime validation for one node of a deserialized, untrusted rule tree, shared
- * by `evaluate` and `describe`. A rule can arrive from JSON that TypeScript never
- * checked, so `null`, a non-object, or a node without a string `kind` would throw
- * a native `TypeError` on the first field read — skipping the `ChartRuleError`
- * escape hatch a caller relies on. Validate before reading fields.
- */
-
-const SCALAR_TYPES: ReadonlySet<string> = new Set(['number', 'string', 'boolean']);
-
-/**
- * Assert `node` is shaped like a rule node — an object carrying a string `kind`.
- * An unrecognised `kind` is *not* rejected here; that is the caller's `switch`
- * default (`UnknownNodeError`), the deliberate "configured in code" signal.
- */
-export function assertRuleNode(node: unknown): asserts node is RuleNode {
-  if (
-    node === null ||
-    typeof node !== 'object' ||
-    Array.isArray(node) ||
-    typeof (node as { kind?: unknown }).kind !== 'string'
-  ) {
-    throw new MalformedRuleError('a rule node must be an object with a string "kind"');
-  }
-}
-
-/**
- * Read a `literal` node's `value`, rejecting a missing or non-scalar one. Without
- * this, `{ kind: 'literal' }` resolves to `undefined` and slips past the caller.
- */
-export function literalValue(node: { value?: unknown }): Scalar {
-  const { value } = node;
-  if (value === null || SCALAR_TYPES.has(typeof value)) {
-    return value as Scalar;
-  }
-  throw new MalformedRuleError(
-    `a literal must carry a scalar value, got ${value === undefined ? 'undefined' : typeof value}`,
-  );
-}