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

package/resources/card-transactions.js

@@ -0,0 +1,116 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardTransactions = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class CardTransactions extends resource_1.APIResource {
+    /**
+     * A list of card transactions.
+     *
+     * - Requires: `Internal Testing`
+     * - Filterable fields: `worker_id`, `transaction_date`, `entity_id`, `vendor_id`,
+     *   `category_id`, `transaction_type`, `card_id`
+     * - Sortable fields: `id`, `created_at`, `updated_at`, `transaction_date`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /card-transactions/?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",
+     *       "worker_id": "string",
+     *       "company_amount": {
+     *         "currency_type": "string",
+     *         "value": "string"
+     *       },
+     *       "merchant_amount": {
+     *         "currency_type": "string",
+     *         "value": "string"
+     *       },
+     *       "transaction_date": "string",
+     *       "accounting_date": "string",
+     *       "gl_sync_state": "NOT_FINALIZED",
+     *       "approval_status": "DRAFT",
+     *       "entity_id": "string",
+     *       "vendor": {
+     *         "id": "string",
+     *         "name": "string"
+     *       },
+     *       "gl_vendor": {
+     *         "id": "string",
+     *         "name": "string",
+     *         "gl_vendor_id": "string"
+     *       },
+     *       "memo": "string",
+     *       "receipt": "string",
+     *       "attachments": [
+     *         "string"
+     *       ],
+     *       "line_items": [
+     *         {}
+     *       ],
+     *       "transaction_type": "CARD_TRANSACTION",
+     *       "authorization_state": "PENDING",
+     *       "card_id": "string"
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/card-transactions/', (pagination_1.PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific card transaction
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /card-transactions/{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, options) {
+        return this._client.get((0, path_1.path) `/card-transactions/${id}/`, options);
+    }
+}
+exports.CardTransactions = CardTransactions;
+//# sourceMappingURL=card-transactions.js.map

package/resources/card-transactions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"card-transactions.js","sourceRoot":"","sources":["../src/resources/card-transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgE;AAEhE,oDAA8C;AAE9C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,IAAI,CACF,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAA,0BAA0C,CAAA,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AA9GD,4CA8GC"}

package/resources/card-transactions.mjs

@@ -0,0 +1,112 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { PageCursorURL } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class CardTransactions extends APIResource {
+    /**
+     * A list of card transactions.
+     *
+     * - Requires: `Internal Testing`
+     * - Filterable fields: `worker_id`, `transaction_date`, `entity_id`, `vendor_id`,
+     *   `category_id`, `transaction_type`, `card_id`
+     * - Sortable fields: `id`, `created_at`, `updated_at`, `transaction_date`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /card-transactions/?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",
+     *       "worker_id": "string",
+     *       "company_amount": {
+     *         "currency_type": "string",
+     *         "value": "string"
+     *       },
+     *       "merchant_amount": {
+     *         "currency_type": "string",
+     *         "value": "string"
+     *       },
+     *       "transaction_date": "string",
+     *       "accounting_date": "string",
+     *       "gl_sync_state": "NOT_FINALIZED",
+     *       "approval_status": "DRAFT",
+     *       "entity_id": "string",
+     *       "vendor": {
+     *         "id": "string",
+     *         "name": "string"
+     *       },
+     *       "gl_vendor": {
+     *         "id": "string",
+     *         "name": "string",
+     *         "gl_vendor_id": "string"
+     *       },
+     *       "memo": "string",
+     *       "receipt": "string",
+     *       "attachments": [
+     *         "string"
+     *       ],
+     *       "line_items": [
+     *         {}
+     *       ],
+     *       "transaction_type": "CARD_TRANSACTION",
+     *       "authorization_state": "PENDING",
+     *       "card_id": "string"
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/card-transactions/', (PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific card transaction
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /card-transactions/{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, options) {
+        return this._client.get(path `/card-transactions/${id}/`, options);
+    }
+}
+//# sourceMappingURL=card-transactions.mjs.map

package/resources/card-transactions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"card-transactions.mjs","sourceRoot":"","sources":["../src/resources/card-transactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,IAAI,CACF,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAA,aAA0C,CAAA,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,sBAAsB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF"}

package/resources/custom-settings.d.mts

@@ -7,7 +7,7 @@ export declare class CustomSettings extends APIResource {
     /**
      * A list of Setting.
      *
-     * - Requires: `Functions API`
+     * - Requires: `API Tier 1`
      * - Sortable fields: `id`, `created_at`, `updated_at`
      *
      * @example HTTP

package/resources/custom-settings.d.ts

@@ -7,7 +7,7 @@ export declare class CustomSettings extends APIResource {
     /**
      * A list of Setting.
      *
-     * - Requires: `Functions API`
+     * - Requires: `API Tier 1`
      * - Sortable fields: `id`, `created_at`, `updated_at`
      *
      * @example HTTP

package/resources/custom-settings.js

@@ -10,7 +10,7 @@ class CustomSettings extends resource_1.APIResource {
     /**
      * A list of Setting.
      *
-     * - Requires: `Functions API`
+     * - Requires: `API Tier 1`
      * - Sortable fields: `id`, `created_at`, `updated_at`
      *
      * @example HTTP

package/resources/custom-settings.mjs

@@ -7,7 +7,7 @@ export class CustomSettings extends APIResource {
     /**
      * A list of Setting.
      *
-     * - Requires: `Functions API`
+     * - Requires: `API Tier 1`
      * - Sortable fields: `id`, `created_at`, `updated_at`
      *
      * @example HTTP

package/resources/earning-types.d.mts

@@ -6,14 +6,33 @@ import { RequestOptions } from "../internal/request-options.mjs";
  */
 export declare class EarningTypes extends APIResource {
     /**
-     * A list of earning-types.
+     * Lists Global Payroll earning types for selecting payroll earnings inputs. Use
+     * the returned `earning_code` in `POST /earnings-inputs/`; the worker's payroll
+     * catalog determines whether that code is available. `company_entity_id` and
+     * `country_code` restrict results together. Conflicting filters return HTTP 200
+     * with empty `results`. Without either filter, returns the company's combined
+     * earning catalog.
+     *
+     * A legal entity can have multiple payroll entities, including sub entities. With
+     * `company_entity_id`, their catalogs are combined and equivalent entries with the
+     * same country, code, display name, configuration, and behavior are merged.
+     * Calculation and tax settings, effective dates, and employment restrictions
+     * participate in comparison. Different configurations remain separate, even when
+     * returned codes and names match. Each merged entry uses the lexicographically
+     * smallest existing earning type ID; it can change when its source entry is
+     * removed. Catalog membership does not guarantee availability to every worker.
+     * Without `company_entity_id`, entries are deduplicated by earning type ID.
+     *
+     * Entity-filtered results are ordered by display name, country, code, and ID.
+     * Pagination does not provide a snapshot during catalog changes. To continue, pass
+     * the returned `next_link` token as `cursor` with the same filters.
      *
      * - Requires: `Global Payroll`
      *
      * @example HTTP
      * Representative request and response shapes.
      * ```
-     * GET /earning-types/?limit=50&cursor=cursor HTTP/1.1
+     * GET /earning-types/?company_entity_id=company_entity_id&country_code=country_code&limit=50&cursor=cursor HTTP/1.1
      * Host: rest.ripplingapis.com
      * Accept: application/json
      * Rippling-Api-Version: 2024-08-01
@@ -46,30 +65,51 @@ export declare class EarningTypes extends APIResource {
 }
 export type EarningTypeListResponsesPageCursorURL = PageCursorURL<EarningTypeListResponse>;
 /**
- * V2 DTO representing a company earning type.
- *
- *     Used by:
- *       - GET /earning-types/  (list)
+ * An earning category available in Global Payroll, such as salary, commission, or
+ * bonus.
  */
 export interface EarningTypeListResponse {
     /**
-     * Unique identifier for the earning type.
+     * Identifier of a source earning type. With `company_entity_id`, equivalent
+     * entries use one existing ID, which can change when its source entry is removed.
+     * Use `earning_code` when submitting payroll earnings inputs.
      */
     id?: string;
     /**
-     * ISO country code where the earning type applies.
+     * Uppercase ISO 3166-1 alpha-2 country code of the payroll catalog, such as `CA`
+     * or `US`.
      */
     country_code?: string;
     /**
-     * Human-readable name of the earning type.
+     * Configured display name of the earning type. Entries with different
+     * configurations can have the same name and `earning_code`.
      */
     display_name?: string;
     /**
-     * Code identifying the earning type (e.g. regular_salary, commission).
+     * Code used to select this earning type in `POST /earnings-inputs/`, such as
+     * `regular_salary` or `commission`. Availability is validated against the worker's
+     * payroll catalog.
      */
     earning_code?: string;
 }
 export interface EarningTypeListParams {
+    /**
+     * Filters earnings to a company legal entity. Use the `id` returned by
+     * `GET /company-legal-entities/`, not a payroll entity ID. Includes the combined
+     * catalogs of linked, non-archived payroll entities, excluding internal shadow
+     * entities. Omit this parameter to use the company-wide catalog. An unknown ID or
+     * an ID outside the authenticated company returns HTTP 200 with empty `results`.
+     * An empty value or a value that is not a 24-character hexadecimal ID returns HTTP
+     * 400 (`VALIDATION_ERROR`).
+     */
+    company_entity_id?: string;
+    /**
+     * Filters earnings by the payroll entity's country. Use an uppercase ISO 3166-1
+     * alpha-2 country code, such as `CA` or `US`; matching is case-sensitive. If
+     * omitted or empty, country does not restrict results. When supplied with
+     * `company_entity_id`, only earnings matching both filters are returned.
+     */
+    country_code?: string;
     cursor?: string;
     /**
      * The maximum number of results to return. Defaults to 50. Maximum is 100.

package/resources/earning-types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"earning-types.d.mts","sourceRoot":"","sources":["../src/resources/earning-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,uBAAuB,CAAC;CAM/E;AAED,MAAM,MAAM,qCAAqC,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE3F;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
+{"version":3,"file":"earning-types.d.mts","sourceRoot":"","sources":["../src/resources/earning-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,uBAAuB,CAAC;CAM/E;AAED,MAAM,MAAM,qCAAqC,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE3F;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/earning-types.d.ts

@@ -6,14 +6,33 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 export declare class EarningTypes extends APIResource {
     /**
-     * A list of earning-types.
+     * Lists Global Payroll earning types for selecting payroll earnings inputs. Use
+     * the returned `earning_code` in `POST /earnings-inputs/`; the worker's payroll
+     * catalog determines whether that code is available. `company_entity_id` and
+     * `country_code` restrict results together. Conflicting filters return HTTP 200
+     * with empty `results`. Without either filter, returns the company's combined
+     * earning catalog.
+     *
+     * A legal entity can have multiple payroll entities, including sub entities. With
+     * `company_entity_id`, their catalogs are combined and equivalent entries with the
+     * same country, code, display name, configuration, and behavior are merged.
+     * Calculation and tax settings, effective dates, and employment restrictions
+     * participate in comparison. Different configurations remain separate, even when
+     * returned codes and names match. Each merged entry uses the lexicographically
+     * smallest existing earning type ID; it can change when its source entry is
+     * removed. Catalog membership does not guarantee availability to every worker.
+     * Without `company_entity_id`, entries are deduplicated by earning type ID.
+     *
+     * Entity-filtered results are ordered by display name, country, code, and ID.
+     * Pagination does not provide a snapshot during catalog changes. To continue, pass
+     * the returned `next_link` token as `cursor` with the same filters.
      *
      * - Requires: `Global Payroll`
      *
      * @example HTTP
      * Representative request and response shapes.
      * ```
-     * GET /earning-types/?limit=50&cursor=cursor HTTP/1.1
+     * GET /earning-types/?company_entity_id=company_entity_id&country_code=country_code&limit=50&cursor=cursor HTTP/1.1
      * Host: rest.ripplingapis.com
      * Accept: application/json
      * Rippling-Api-Version: 2024-08-01
@@ -46,30 +65,51 @@ export declare class EarningTypes extends APIResource {
 }
 export type EarningTypeListResponsesPageCursorURL = PageCursorURL<EarningTypeListResponse>;
 /**
- * V2 DTO representing a company earning type.
- *
- *     Used by:
- *       - GET /earning-types/  (list)
+ * An earning category available in Global Payroll, such as salary, commission, or
+ * bonus.
  */
 export interface EarningTypeListResponse {
     /**
-     * Unique identifier for the earning type.
+     * Identifier of a source earning type. With `company_entity_id`, equivalent
+     * entries use one existing ID, which can change when its source entry is removed.
+     * Use `earning_code` when submitting payroll earnings inputs.
      */
     id?: string;
     /**
-     * ISO country code where the earning type applies.
+     * Uppercase ISO 3166-1 alpha-2 country code of the payroll catalog, such as `CA`
+     * or `US`.
      */
     country_code?: string;
     /**
-     * Human-readable name of the earning type.
+     * Configured display name of the earning type. Entries with different
+     * configurations can have the same name and `earning_code`.
      */
     display_name?: string;
     /**
-     * Code identifying the earning type (e.g. regular_salary, commission).
+     * Code used to select this earning type in `POST /earnings-inputs/`, such as
+     * `regular_salary` or `commission`. Availability is validated against the worker's
+     * payroll catalog.
      */
     earning_code?: string;
 }
 export interface EarningTypeListParams {
+    /**
+     * Filters earnings to a company legal entity. Use the `id` returned by
+     * `GET /company-legal-entities/`, not a payroll entity ID. Includes the combined
+     * catalogs of linked, non-archived payroll entities, excluding internal shadow
+     * entities. Omit this parameter to use the company-wide catalog. An unknown ID or
+     * an ID outside the authenticated company returns HTTP 200 with empty `results`.
+     * An empty value or a value that is not a 24-character hexadecimal ID returns HTTP
+     * 400 (`VALIDATION_ERROR`).
+     */
+    company_entity_id?: string;
+    /**
+     * Filters earnings by the payroll entity's country. Use an uppercase ISO 3166-1
+     * alpha-2 country code, such as `CA` or `US`; matching is case-sensitive. If
+     * omitted or empty, country does not restrict results. When supplied with
+     * `company_entity_id`, only earnings matching both filters are returned.
+     */
+    country_code?: string;
     cursor?: string;
     /**
      * The maximum number of results to return. Defaults to 50. Maximum is 100.

package/resources/earning-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"earning-types.d.ts","sourceRoot":"","sources":["../src/resources/earning-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,uBAAuB,CAAC;CAM/E;AAED,MAAM,MAAM,qCAAqC,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE3F;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
+{"version":3,"file":"earning-types.d.ts","sourceRoot":"","sources":["../src/resources/earning-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,uBAAuB,CAAC;CAM/E;AAED,MAAM,MAAM,qCAAqC,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE3F;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/earning-types.js

@@ -9,14 +9,33 @@ const pagination_1 = require("../core/pagination.js");
  */
 class EarningTypes extends resource_1.APIResource {
     /**
-     * A list of earning-types.
+     * Lists Global Payroll earning types for selecting payroll earnings inputs. Use
+     * the returned `earning_code` in `POST /earnings-inputs/`; the worker's payroll
+     * catalog determines whether that code is available. `company_entity_id` and
+     * `country_code` restrict results together. Conflicting filters return HTTP 200
+     * with empty `results`. Without either filter, returns the company's combined
+     * earning catalog.
+     *
+     * A legal entity can have multiple payroll entities, including sub entities. With
+     * `company_entity_id`, their catalogs are combined and equivalent entries with the
+     * same country, code, display name, configuration, and behavior are merged.
+     * Calculation and tax settings, effective dates, and employment restrictions
+     * participate in comparison. Different configurations remain separate, even when
+     * returned codes and names match. Each merged entry uses the lexicographically
+     * smallest existing earning type ID; it can change when its source entry is
+     * removed. Catalog membership does not guarantee availability to every worker.
+     * Without `company_entity_id`, entries are deduplicated by earning type ID.
+     *
+     * Entity-filtered results are ordered by display name, country, code, and ID.
+     * Pagination does not provide a snapshot during catalog changes. To continue, pass
+     * the returned `next_link` token as `cursor` with the same filters.
      *
      * - Requires: `Global Payroll`
      *
      * @example HTTP
      * Representative request and response shapes.
      * ```
-     * GET /earning-types/?limit=50&cursor=cursor HTTP/1.1
+     * GET /earning-types/?company_entity_id=company_entity_id&country_code=country_code&limit=50&cursor=cursor HTTP/1.1
      * Host: rest.ripplingapis.com
      * Accept: application/json
      * Rippling-Api-Version: 2024-08-01

package/resources/earning-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"earning-types.js","sourceRoot":"","sources":["../src/resources/earning-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAC/C,sDAAgE;AAGhE;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,0BAAsC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA/CD,oCA+CC"}
+{"version":3,"file":"earning-types.js","sourceRoot":"","sources":["../src/resources/earning-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAC/C,sDAAgE;AAGhE;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,0BAAsC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAlED,oCAkEC"}

package/resources/earning-types.mjs

@@ -6,14 +6,33 @@ import { PageCursorURL } from "../core/pagination.mjs";
  */
 export class EarningTypes extends APIResource {
     /**
-     * A list of earning-types.
+     * Lists Global Payroll earning types for selecting payroll earnings inputs. Use
+     * the returned `earning_code` in `POST /earnings-inputs/`; the worker's payroll
+     * catalog determines whether that code is available. `company_entity_id` and
+     * `country_code` restrict results together. Conflicting filters return HTTP 200
+     * with empty `results`. Without either filter, returns the company's combined
+     * earning catalog.
+     *
+     * A legal entity can have multiple payroll entities, including sub entities. With
+     * `company_entity_id`, their catalogs are combined and equivalent entries with the
+     * same country, code, display name, configuration, and behavior are merged.
+     * Calculation and tax settings, effective dates, and employment restrictions
+     * participate in comparison. Different configurations remain separate, even when
+     * returned codes and names match. Each merged entry uses the lexicographically
+     * smallest existing earning type ID; it can change when its source entry is
+     * removed. Catalog membership does not guarantee availability to every worker.
+     * Without `company_entity_id`, entries are deduplicated by earning type ID.
+     *
+     * Entity-filtered results are ordered by display name, country, code, and ID.
+     * Pagination does not provide a snapshot during catalog changes. To continue, pass
+     * the returned `next_link` token as `cursor` with the same filters.
      *
      * - Requires: `Global Payroll`
      *
      * @example HTTP
      * Representative request and response shapes.
      * ```
-     * GET /earning-types/?limit=50&cursor=cursor HTTP/1.1
+     * GET /earning-types/?company_entity_id=company_entity_id&country_code=country_code&limit=50&cursor=cursor HTTP/1.1
      * Host: rest.ripplingapis.com
      * Accept: application/json
      * Rippling-Api-Version: 2024-08-01

package/resources/earning-types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"earning-types.mjs","sourceRoot":"","sources":["../src/resources/earning-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAGhE;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,aAAsC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"earning-types.mjs","sourceRoot":"","sources":["../src/resources/earning-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAGhE;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,aAAsC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/hires.d.mts

@@ -47,7 +47,6 @@ export declare class Hires extends APIResource {
      * Content-Type: application/json
      *
      * {
-     *   "ack": false,
      *   "results": [
      *     {
      *       "client_request_id": "string",
@@ -74,10 +73,6 @@ export declare class Hires extends APIResource {
     create(params: HireCreateParams, options?: RequestOptions): APIPromise<HireCreateResponse>;
 }
 export interface HireCreateResponse {
-    /**
-     * True when the envelope was accepted for processing.
-     */
-    ack: boolean;
     /**
      * One result per request hire, in request order. HTTP 200 means the envelope was
      * accepted; each item's status is the outcome.