@rippling/rippling-sdk 0.2.0-alpha.28 → 0.2.0-alpha.30

package/src/resources/job-codes.ts

@@ -20,7 +20,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobCodes extends APIResource {
   /**
-   * A List of job codes
+   * A list of job codes.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `job_dimension_id`, `group_id`
@@ -54,7 +54,7 @@ export class JobCodes extends APIResource {
   }
 
   /**
-   * Updated a specific job code
+   * Update a specific job code.
    */
   update(id: string, body: JobCodeUpdateParams, options?: RequestOptions): APIPromise<JobCode> {
     return this._client.patch(path`/job-codes/${id}/`, { body, ...options });
@@ -71,7 +71,7 @@ export class JobCodes extends APIResource {
   }
 
   /**
-   * A List of attribute change logs
+   * A list of attribute change logs.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `changed_by_worker`

package/src/resources/job-dimensions.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobDimensions extends APIResource {
   /**
-   * A List of job dimensions
+   * A list of job dimensions.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `name`
@@ -41,7 +41,7 @@ export class JobDimensions extends APIResource {
   }
 
   /**
-   * Updated a specific job dimension
+   * Update a specific job dimension.
    */
   update(id: string, body: JobDimensionUpdateParams, options?: RequestOptions): APIPromise<JobDimension> {
     return this._client.patch(path`/job-dimensions/${id}/`, { body, ...options });

package/src/resources/job-functions.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobFunctions extends APIResource {
   /**
-   * A List of job functions
+   * A list of job functions.
    *
    * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/job-pay-rate-exceptions.ts

@@ -15,7 +15,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobPayRateExceptions extends APIResource {
   /**
-   * A List of job pay rate exceptions
+   * A list of job pay rate exceptions.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `job_code_id`
@@ -44,7 +44,7 @@ export class JobPayRateExceptions extends APIResource {
   }
 
   /**
-   * A List of attribute change logs
+   * A list of attribute change logs.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `changed_by_worker`

package/src/resources/job-requisitions.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class JobRequisitions extends APIResource {
   /**
-   * A List of job requisitions
+   * A list of job requisitions.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/kiosk-badges.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class KioskBadges extends APIResource {
   /**
-   * A List of kiosk badges
+   * A list of kiosk badges.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `badge_id`
@@ -50,7 +50,7 @@ export class KioskBadges extends APIResource {
   }
 
   /**
-   * Updated a specific kiosk badge
+   * Update a specific kiosk badge.
    */
   update(
     id: string,

package/src/resources/leave-accruals.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class LeaveAccruals extends APIResource {
   /**
-   * A List of leave accruals
+   * A list of leave accruals.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `leave_type_id`, `accrual_date`

package/src/resources/leave-balances.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class LeaveBalances extends APIResource {
   /**
-   * A List of leave balances
+   * A list of leave balances.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `leave_type_id`

package/src/resources/leave-requests.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class LeaveRequests extends APIResource {
   /**
-   * A List of leave requests
+   * A list of leave requests.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `requester_id`, `reviewer_id`, `status`,
@@ -51,7 +51,7 @@ export class LeaveRequests extends APIResource {
   }
 
   /**
-   * Updated a specific leave request
+   * Update a specific leave request.
    */
   update(
     id: string,

package/src/resources/leave-types.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class LeaveTypes extends APIResource {
   /**
-   * A List of leave types
+   * A list of leave types.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `name`

package/src/resources/legal-entities.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class LegalEntities extends APIResource {
   /**
-   * A List of legal entities
+   * A list of legal entities.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `parent`, `company`

package/src/resources/levels.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class Levels extends APIResource {
   /**
-   * A List of levels
+   * A list of levels.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `parent`, `track`

package/src/resources/location-factors.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class LocationFactors extends APIResource {
   /**
-   * A List of location factors
+   * A list of location factors.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/metadata/components.ts

@@ -9,9 +9,9 @@ import { RequestOptions } from '../../internal/request-options';
  */
 export class Components extends APIResource {
   /**
-   * A List of metadata components
+   * A list of metadata components.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Metadata Platform API`
    */
   list(options?: RequestOptions): PagePromise<ComponentListResponsesPageCursorURL, ComponentListResponse> {
     return this._client.getAPIList('/metadata/components/', PageCursorURL<ComponentListResponse>, options);

package/src/resources/metadata/metadata.ts

@@ -19,9 +19,9 @@ export class Metadata extends APIResource {
   types: TypesAPI.Types = new TypesAPI.Types(this._client);
 
   /**
-   * A List of metadata components
+   * A list of metadata components.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Metadata Platform API`
    */
   list(options?: RequestOptions): PagePromise<MetadataListResponsesPageCursorURL, MetadataListResponse> {
     return this._client.getAPIList('/metadata/', PageCursorURL<MetadataListResponse>, options);

package/src/resources/metadata/summary.ts

@@ -9,9 +9,9 @@ import { RequestOptions } from '../../internal/request-options';
  */
 export class Summary extends APIResource {
   /**
-   * A List of metadata summary
+   * A list of metadata summary.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Metadata Platform API`
    */
   list(options?: RequestOptions): PagePromise<SummaryListResponsesPageCursorURL, SummaryListResponse> {
     return this._client.getAPIList('/metadata/summary/', PageCursorURL<SummaryListResponse>, options);

package/src/resources/metadata/types.ts

@@ -9,9 +9,9 @@ import { RequestOptions } from '../../internal/request-options';
  */
 export class Types extends APIResource {
   /**
-   * A List of metadata types
+   * A list of metadata types.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Metadata Platform API`
    */
   list(options?: RequestOptions): PagePromise<TypeListResponsesPageCursorURL, TypeListResponse> {
     return this._client.getAPIList('/metadata/types/', PageCursorURL<TypeListResponse>, options);

package/src/resources/object-categories.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class ObjectCategories extends APIResource {
   /**
-   * A List of object categories
+   * A list of object categories.
    *
    * - Requires: `API Tier 1`
    */
@@ -21,7 +21,7 @@ export class ObjectCategories extends APIResource {
   }
 
   /**
-   * Create a new object category
+   * Create a new object category.
    */
   create(
     body: ObjectCategoryCreateParams | null | undefined = {},
@@ -31,14 +31,14 @@ export class ObjectCategories extends APIResource {
   }
 
   /**
-   * Retrieve a specific object category
+   * Retrieve a specific object category.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<ObjectCategory> {
     return this._client.get(path`/object-categories/${id}/`, options);
   }
 
   /**
-   * Updated a specific object category
+   * Update a specific object category.
    */
   update(
     id: string,
@@ -49,7 +49,7 @@ export class ObjectCategories extends APIResource {
   }
 
   /**
-   * Delete a object category
+   * Delete a object category.
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/object-categories/${id}/`, {
@@ -89,14 +89,26 @@ export interface ObjectCategory {
 }
 
 export interface ObjectCategoryCreateParams {
+  /**
+   * A description of the category.
+   */
   description?: string;
 
+  /**
+   * The name of the category.
+   */
   name?: string;
 }
 
 export interface ObjectCategoryUpdateParams {
+  /**
+   * A description of the category.
+   */
   description?: string;
 
+  /**
+   * The name of the category.
+   */
   name?: string;
 }
 

package/src/resources/payroll-runs.ts

@@ -0,0 +1,251 @@
+// 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';
+
+/**
+ * Payroll runs for the company
+ */
+export class PayrollRuns extends APIResource {
+  /**
+   * A list of payroll-runs.
+   *
+   * - Requires: `Payroll API`
+   * - Sortable fields: `check_date`
+   */
+  list(
+    query: PayrollRunListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PayrollRunListResponsesPageCursorURL, PayrollRunListResponse> {
+    return this._client.getAPIList('/payroll-runs/', PageCursorURL<PayrollRunListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific payroll-run
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PayrollRunRetrieveResponse> {
+    return this._client.get(path`/payroll-runs/${id}/`, options);
+  }
+}
+
+export type PayrollRunListResponsesPageCursorURL = PageCursorURL<PayrollRunListResponse>;
+
+/**
+ * V2 DTO representing a single payroll run.
+ *
+ *     Used by:
+ *       - GET /payroll-runs/      (list)
+ *       - GET /payroll-runs/{id}  (retrieve)
+ */
+export interface PayrollRunListResponse {
+  /**
+   * Unique identifier for the payroll run.
+   */
+  id?: string;
+
+  /**
+   * Deadline for approving the payroll run.
+   */
+  approval_deadline?: string;
+
+  /**
+   * Timestamp when the run was approved.
+   */
+  approved_at?: string;
+
+  /**
+   * Date the paycheck is issued.
+   */
+  check_date?: string;
+
+  /**
+   * Identifier linking this payroll run to the company's legal entity in the HRIS
+   * system.
+   */
+  company_entity_id?: string;
+
+  /**
+   * ISO country code where the payroll run applies.
+   */
+  country_code?: string;
+
+  /**
+   * Date funds are debited from the company's account.
+   */
+  debit_date?: string;
+
+  /**
+   * Deadline after which the run is locked for changes.
+   */
+  lock_deadline?: string;
+
+  /**
+   * Timestamp when the run was marked as paid.
+   */
+  paid_at?: string;
+
+  /**
+   * Pay period details for this run.
+   */
+  pay_period?: PayrollRunListResponse.PayPeriod;
+
+  /**
+   * Payment method used (e.g. WIRE, ACH).
+   */
+  payment_type?: string;
+
+  /**
+   * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+   */
+  run_state?: string;
+
+  /**
+   * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+   */
+  run_type?: string;
+
+  /**
+   * Human-readable title of the payroll run.
+   */
+  title?: string;
+}
+
+export namespace PayrollRunListResponse {
+  /**
+   * Pay period details for this run.
+   */
+  export interface PayPeriod {
+    /**
+     * End date of the pay period.
+     */
+    end_date?: string;
+
+    /**
+     * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+     */
+    pay_frequency?: string;
+
+    /**
+     * Start date of the pay period.
+     */
+    start_date?: string;
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface PayrollRunRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Unique identifier for the payroll run.
+   */
+  id?: string;
+
+  /**
+   * Deadline for approving the payroll run.
+   */
+  approval_deadline?: string;
+
+  /**
+   * Timestamp when the run was approved.
+   */
+  approved_at?: string;
+
+  /**
+   * Date the paycheck is issued.
+   */
+  check_date?: string;
+
+  /**
+   * Identifier linking this payroll run to the company's legal entity in the HRIS
+   * system.
+   */
+  company_entity_id?: string;
+
+  /**
+   * ISO country code where the payroll run applies.
+   */
+  country_code?: string;
+
+  /**
+   * Date funds are debited from the company's account.
+   */
+  debit_date?: string;
+
+  /**
+   * Deadline after which the run is locked for changes.
+   */
+  lock_deadline?: string;
+
+  /**
+   * Timestamp when the run was marked as paid.
+   */
+  paid_at?: string;
+
+  /**
+   * Pay period details for this run.
+   */
+  pay_period?: PayrollRunRetrieveResponse.PayPeriod;
+
+  /**
+   * Payment method used (e.g. WIRE, ACH).
+   */
+  payment_type?: string;
+
+  /**
+   * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+   */
+  run_state?: string;
+
+  /**
+   * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+   */
+  run_type?: string;
+
+  /**
+   * Human-readable title of the payroll run.
+   */
+  title?: string;
+}
+
+export namespace PayrollRunRetrieveResponse {
+  /**
+   * Pay period details for this run.
+   */
+  export interface PayPeriod {
+    /**
+     * End date of the pay period.
+     */
+    end_date?: string;
+
+    /**
+     * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+     */
+    pay_frequency?: string;
+
+    /**
+     * Start date of the pay period.
+     */
+    start_date?: string;
+  }
+}
+
+export interface PayrollRunListParams {
+  order_by?: string;
+}
+
+export declare namespace PayrollRuns {
+  export {
+    type PayrollRunListResponse as PayrollRunListResponse,
+    type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse,
+    type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL,
+    type PayrollRunListParams as PayrollRunListParams,
+  };
+}

package/src/resources/platform-capabilities.ts

@@ -9,9 +9,9 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class PlatformCapabilities extends APIResource {
   /**
-   * A List of platform capabilities
+   * A list of platform capabilities.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Platform Capabilities API`
    */
   list(
     options?: RequestOptions,

package/src/resources/report-runs.ts

@@ -122,6 +122,11 @@ export interface ReportRunCreateParams {
    */
   report_id: string;
 
+  /**
+   * Optional list of filters to apply when running the report
+   */
+  filters?: Array<ReportRunCreateParams.Filter> | null;
+
   /**
    * Formatting options for currency fields
    */
@@ -156,6 +161,91 @@ export interface ReportRunCreateParams {
 }
 
 export namespace ReportRunCreateParams {
+  /**
+   * A single filter to apply when running a report. The expected shape of 'value'
+   * depends on the operator — see the FilterOperator description for details.
+   */
+  export interface Filter {
+    /**
+     * The ID of the report field to filter on
+     */
+    field_id: string;
+
+    /**
+     * Comparison operator for the filter. Single-value operators (eq, ne, gt, gte, lt,
+     * lte, starts_with, ends_with, contains, not_contains, before, after) require a
+     * scalar value. List operators (in, not_in) require a non-empty array. Range
+     * operators (between, not_between) require an object with 'from' and 'to' keys.
+     * No-value operators (is_empty, is_not_empty) do not require a value. Rolling-date
+     * operators (last_n, next_n) require an object with 'unit' (day, week, month,
+     * year) and 'n' (integer). Calendar-date operators (current_calendar,
+     * previous_calendar) require a unit string (day, week, month, quarter, year).
+     */
+    operator:
+      | 'eq'
+      | 'ne'
+      | 'in'
+      | 'not_in'
+      | 'starts_with'
+      | 'ends_with'
+      | 'contains'
+      | 'not_contains'
+      | 'gt'
+      | 'gte'
+      | 'lt'
+      | 'lte'
+      | 'between'
+      | 'not_between'
+      | 'is_empty'
+      | 'is_not_empty'
+      | 'before'
+      | 'after'
+      | 'last_n'
+      | 'next_n'
+      | 'current_calendar'
+      | 'previous_calendar';
+
+    /**
+     * The filter value. Shape depends on the operator: scalar for single-value
+     * operators; array for list operators; RangeValue object ({from, to}) for range
+     * operators; RollingDateValue object ({unit, n}) for rolling-date operators; unit
+     * string for calendar-date operators; omitted or null for is_empty/is_not_empty.
+     */
+    value?: string | number | boolean | Array<unknown> | Filter.RangeValue | Filter.RollingDateValue | null;
+  }
+
+  export namespace Filter {
+    /**
+     * Range bounds for 'between' and 'not_between' operators
+     */
+    export interface RangeValue {
+      /**
+       * Lower bound of the range (inclusive)
+       */
+      from: number | string;
+
+      /**
+       * Upper bound of the range (inclusive)
+       */
+      to: number | string;
+    }
+
+    /**
+     * Rolling date window for 'last_n' and 'next_n' operators
+     */
+    export interface RollingDateValue {
+      /**
+       * Number of units
+       */
+      n: number;
+
+      /**
+       * Unit of time for rolling/calendar date filters
+       */
+      unit: 'day' | 'week' | 'month' | 'quarter' | 'year';
+    }
+  }
+
   /**
    * Formatting options for currency fields
    */