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

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`

package/src/resources/work-locations.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class WorkLocations extends APIResource {
   /**
-   * A List of work locations
+   * A list of work locations.
    *
    * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -41,7 +41,7 @@ export class WorkLocations extends APIResource {
   }
 
   /**
-   * Updated a specific work location
+   * Update a specific work location.
    */
   update(id: string, body: WorkLocationUpdateParams, options?: RequestOptions): APIPromise<WorkLocation> {
     return this._client.patch(path`/work-locations/${id}/`, { body, ...options });

package/src/resources/workers.ts

@@ -19,7 +19,7 @@ import { path } from '../internal/utils/path';
  */
 export class Workers extends APIResource {
   /**
-   * A List of workers
+   * A list of workers.
    *
    * - Requires: `API Tier 1`
    * - Filterable fields: `status`, `work_email`, `user_id`, `created_at`,