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

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
    */

package/src/resources/reports/available-filters.ts

@@ -0,0 +1,60 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Report data for company
+ */
+export class AvailableFilters extends APIResource {
+  /**
+   * Returns the list of fields that can be used to filter a report run, along with
+   * the operators each field supports.
+   */
+  retrieve(reportID: string, options?: RequestOptions): APIPromise<AvailableFilterRetrieveResponse> {
+    return this._client.get(path`/reports/${reportID}/available-filters/`, options);
+  }
+}
+
+/**
+ * Response for GET /reports/{report_id}/available-filters
+ */
+export interface AvailableFilterRetrieveResponse {
+  /**
+   * List of filterable fields with their supported operators
+   */
+  data: Array<AvailableFilterRetrieveResponse.Data>;
+}
+
+export namespace AvailableFilterRetrieveResponse {
+  /**
+   * Describes a field the client can filter on when running a report
+   */
+  export interface Data {
+    /**
+     * Stable field identifier used when applying filters
+     */
+    field_id: string;
+
+    /**
+     * Human-readable display name of the field
+     */
+    field_name: string;
+
+    /**
+     * Operators supported by this field
+     */
+    operators: Array<string>;
+
+    /**
+     * Data type of a filterable field
+     */
+    type: 'string' | 'number' | 'date' | 'datetime' | 'enum' | 'boolean';
+  }
+}
+
+export declare namespace AvailableFilters {
+  export { type AvailableFilterRetrieveResponse as AvailableFilterRetrieveResponse };
+}

package/src/resources/reports/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { AvailableFilters, type AvailableFilterRetrieveResponse } from './available-filters';
+export { Reports, type ReportRetrieveResponse } from './reports';

package/src/resources/reports/reports.ts

@@ -0,0 +1,112 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AvailableFiltersAPI from './available-filters';
+import { AvailableFilterRetrieveResponse, AvailableFilters } from './available-filters';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Report data for company
+ */
+export class Reports extends APIResource {
+  availableFilters: AvailableFiltersAPI.AvailableFilters = new AvailableFiltersAPI.AvailableFilters(
+    this._client,
+  );
+
+  /**
+   * Retrieve a specific report by its ID
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<ReportRetrieveResponse> {
+    return this._client.get(path`/reports/${id}/`, options);
+  }
+}
+
+/**
+ * A report definition including its output fields and saved filters
+ */
+export interface ReportRetrieveResponse {
+  /**
+   * Unique identifier of the report
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Display name of the report
+   */
+  name: string;
+
+  /**
+   * Attributes (columns) in the report output, with field_id and field_name
+   */
+  output_fields: Array<ReportRetrieveResponse.OutputField>;
+
+  /**
+   * Filters currently saved on the report
+   */
+  saved_filters: Array<ReportRetrieveResponse.SavedFilter>;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+}
+
+export namespace ReportRetrieveResponse {
+  /**
+   * An attribute (column) in the report output
+   */
+  export interface OutputField {
+    /**
+     * Stable field identifier
+     */
+    field_id: string;
+
+    /**
+     * Human-readable display name of the output field
+     */
+    field_name: string;
+  }
+
+  /**
+   * A filter currently saved on the report
+   */
+  export interface SavedFilter {
+    /**
+     * Stable field identifier the filter applies to
+     */
+    field_id: string;
+
+    /**
+     * Human-readable display name of the filtered field
+     */
+    field_name: string;
+
+    /**
+     * Filter operator applied to the field
+     */
+    operator: string;
+
+    /**
+     * Filter value; shape depends on the operator
+     */
+    value?: unknown;
+  }
+}
+
+Reports.AvailableFilters = AvailableFilters;
+
+export declare namespace Reports {
+  export { type ReportRetrieveResponse as ReportRetrieveResponse };
+
+  export {
+    AvailableFilters as AvailableFilters,
+    type AvailableFilterRetrieveResponse as AvailableFilterRetrieveResponse,
+  };
+}

package/src/resources/reports.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './reports/index';

package/src/resources/schedules.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class Schedules extends APIResource {
   /**
-   * A List of schedules
+   * A list of schedules.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `managers`, `observers`, `members`
@@ -48,7 +48,7 @@ export class Schedules extends APIResource {
   }
 
   /**
-   * Updated a specific schedule
+   * Update a specific schedule.
    */
   update(
     id: string,

package/src/resources/shift-inputs.ts

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

package/src/resources/shiftassignments.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class Shiftassignments extends APIResource {
   /**
-   * A List of shift assignments
+   * A list of shift assignments.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `schedule_id`, `shift_data.start_time`,
@@ -53,7 +53,7 @@ export class Shiftassignments extends APIResource {
   }
 
   /**
-   * Updated a specific shift assignment
+   * Update a specific shift assignment.
    */
   update(
     id: string,

package/src/resources/teams.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class Teams extends APIResource {
   /**
-   * A List of teams
+   * A list of teams.
    *
    * - Requires: `API Tier 1`
    * - Expandable fields: `parent`

package/src/resources/time-cards.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class TimeCards extends APIResource {
   /**
-   * A List of time cards
+   * A list of time cards.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `pay_period.start_date`, `worker_id`

package/src/resources/time-entries.ts

@@ -15,7 +15,7 @@ import { path } from '../internal/utils/path';
  */
 export class TimeEntries extends APIResource {
   /**
-   * A List of time entries
+   * A list of time entries.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `start_time`, `pay_period.start_date`,
@@ -52,7 +52,7 @@ export class TimeEntries extends APIResource {
   }
 
   /**
-   * Updated a specific time entry
+   * Update a specific time entry.
    */
   update(
     id: string,

package/src/resources/titles.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class Titles extends APIResource {
   /**
-   * A List of titles
+   * A list of titles.
    *
    * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -40,7 +40,7 @@ export class Titles extends APIResource {
   }
 
   /**
-   * Updated a specific title
+   * Update a specific title.
    */
   update(id: string, body: TitleUpdateParams, options?: RequestOptions): APIPromise<TitleUpdateResponse> {
     return this._client.patch(path`/titles/${id}/`, { body, ...options });

package/src/resources/tracks.ts

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

package/src/resources/unassignedshifts.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class Unassignedshifts extends APIResource {
   /**
-   * A List of unassigned shifts
+   * A list of unassigned shifts.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `schedule_id`, `shift_data.start_time`,
@@ -53,7 +53,7 @@ export class Unassignedshifts extends APIResource {
   }
 
   /**
-   * Updated a specific unassigned shift
+   * Update a specific unassigned shift.
    */
   update(
     id: string,

package/src/resources/users.ts

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