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

package/src/resources/teams.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Teams at the company
+ */
 export class Teams extends APIResource {
   /**
    * A List of teams
@@ -19,7 +22,7 @@ export class Teams extends APIResource {
     query: TeamListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<TeamsPageCursorURL, Team> {
-    return this._client.getAPIList('/teams', PageCursorURL<Team>, { query, ...options });
+    return this._client.getAPIList('/teams/', PageCursorURL<Team>, { query, ...options });
   }
 
   /**
@@ -30,7 +33,7 @@ export class Teams extends APIResource {
     query: TeamRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<TeamRetrieveResponse> {
-    return this._client.get(path`/teams/${id}`, { query, ...options });
+    return this._client.get(path`/teams/${id}/`, { query, ...options });
   }
 }
 

package/src/resources/time-cards.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Time entries submitted by workers
+ */
 export class TimeCards extends APIResource {
   /**
    * A List of time cards
@@ -21,7 +24,7 @@ export class TimeCards extends APIResource {
     query: TimeCardListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<TimeCardsPageCursorURL, TimeCard> {
-    return this._client.getAPIList('/time-cards', PageCursorURL<TimeCard>, { query, ...options });
+    return this._client.getAPIList('/time-cards/', PageCursorURL<TimeCard>, { query, ...options });
   }
 
   /**
@@ -32,7 +35,7 @@ export class TimeCards extends APIResource {
     query: TimeCardRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<TimeCardRetrieveResponse> {
-    return this._client.get(path`/time-cards/${id}`, { query, ...options });
+    return this._client.get(path`/time-cards/${id}/`, { query, ...options });
   }
 }
 

package/src/resources/time-entries.ts

@@ -10,12 +10,16 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Time entries submitted by workers
+ */
 export class TimeEntries extends APIResource {
   /**
    * A List of time entries
    *
    * - Requires: `API Tier 2`
-   * - Filterable fields: `worker_id`, `start_time`, `pay_period.start_date`
+   * - Filterable fields: `worker_id`, `start_time`, `pay_period.start_date`,
+   *   `updated_at`
    * - Expandable fields: `worker`, `time_card`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
@@ -23,7 +27,7 @@ export class TimeEntries extends APIResource {
     query: TimeEntryListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<TimeEntryListResponsesPageCursorURL, TimeEntryListResponse> {
-    return this._client.getAPIList('/time-entries', PageCursorURL<TimeEntryListResponse>, {
+    return this._client.getAPIList('/time-entries/', PageCursorURL<TimeEntryListResponse>, {
       query,
       ...options,
     });
@@ -33,7 +37,7 @@ export class TimeEntries extends APIResource {
    * Create a new time entry
    */
   create(body: TimeEntryCreateParams, options?: RequestOptions): APIPromise<TimeEntryCreateResponse> {
-    return this._client.post('/time-entries', { body, ...options });
+    return this._client.post('/time-entries/', { body, ...options });
   }
 
   /**
@@ -44,7 +48,7 @@ export class TimeEntries extends APIResource {
     query: TimeEntryRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<TimeEntryRetrieveResponse> {
-    return this._client.get(path`/time-entries/${id}`, { query, ...options });
+    return this._client.get(path`/time-entries/${id}/`, { query, ...options });
   }
 
   /**
@@ -55,14 +59,14 @@ export class TimeEntries extends APIResource {
     body: TimeEntryUpdateParams,
     options?: RequestOptions,
   ): APIPromise<TimeEntryUpdateResponse> {
-    return this._client.patch(path`/time-entries/${id}`, { body, ...options });
+    return this._client.patch(path`/time-entries/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a time entry
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/time-entries/${id}`, {
+    return this._client.delete(path`/time-entries/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });

package/src/resources/titles.ts

@@ -8,6 +8,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job titles used by the company
+ */
 export class Titles extends APIResource {
   /**
    * A List of titles
@@ -19,35 +22,35 @@ export class Titles extends APIResource {
     query: TitleListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<TitleListResponsesPageCursorURL, TitleListResponse> {
-    return this._client.getAPIList('/titles', PageCursorURL<TitleListResponse>, { query, ...options });
+    return this._client.getAPIList('/titles/', PageCursorURL<TitleListResponse>, { query, ...options });
   }
 
   /**
    * Create a new title
    */
   create(body: TitleCreateParams, options?: RequestOptions): APIPromise<TitleCreateResponse> {
-    return this._client.post('/titles', { body, ...options });
+    return this._client.post('/titles/', { body, ...options });
   }
 
   /**
    * Retrieve a specific title
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<TitleRetrieveResponse> {
-    return this._client.get(path`/titles/${id}`, options);
+    return this._client.get(path`/titles/${id}/`, options);
   }
 
   /**
    * Updated a specific title
    */
   update(id: string, body: TitleUpdateParams, options?: RequestOptions): APIPromise<TitleUpdateResponse> {
-    return this._client.patch(path`/titles/${id}`, { body, ...options });
+    return this._client.patch(path`/titles/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a title
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/titles/${id}`, {
+    return this._client.delete(path`/titles/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });

package/src/resources/tracks.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Levels and tracks used by the company for workers
+ */
 export class Tracks extends APIResource {
   /**
    * A List of tracks
@@ -18,14 +21,14 @@ export class Tracks extends APIResource {
     query: TrackListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<TracksPageCursorURL, Track> {
-    return this._client.getAPIList('/tracks', PageCursorURL<Track>, { query, ...options });
+    return this._client.getAPIList('/tracks/', PageCursorURL<Track>, { query, ...options });
   }
 
   /**
    * Retrieve a specific track
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<TrackRetrieveResponse> {
-    return this._client.get(path`/tracks/${id}`, options);
+    return this._client.get(path`/tracks/${id}/`, options);
   }
 }
 

package/src/resources/unassigned-shifts.ts

@@ -7,6 +7,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Unassigned shifts that are part of a schedule
+ */
 export class UnassignedShifts extends APIResource {
   /**
    * Update custom fields for a unassigned shift. The request body should contain a
@@ -25,7 +28,7 @@ export class UnassignedShifts extends APIResource {
     body: UnassignedShiftUpdateCustomfieldsParams,
     options?: RequestOptions,
   ): APIPromise<UnassignedShiftUpdateCustomfieldsResponse> {
-    return this._client.patch(path`/unassignedshifts/${id}/customfields`, { body, ...options });
+    return this._client.patch(path`/unassignedshifts/${id}/customfields/`, { body, ...options });
   }
 
   /**
@@ -47,7 +50,7 @@ export class UnassignedShifts extends APIResource {
     body: UnassignedShiftAssignParams,
     options?: RequestOptions,
   ): APIPromise<UnassignedShiftAssignResponse> {
-    return this._client.post(path`/unassignedshifts/${id}/assign`, { body, ...options });
+    return this._client.post(path`/unassignedshifts/${id}/assign/`, { body, ...options });
   }
 }
 

package/src/resources/unassignedshifts.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Unassigned shifts that are part of a schedule
+ */
 export class Unassignedshifts extends APIResource {
   /**
    * A List of unassigned shifts
@@ -22,7 +25,7 @@ export class Unassignedshifts extends APIResource {
     query: UnassignedshiftListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<UnassignedshiftListResponsesPageCursorURL, UnassignedshiftListResponse> {
-    return this._client.getAPIList('/unassignedshifts', PageCursorURL<UnassignedshiftListResponse>, {
+    return this._client.getAPIList('/unassignedshifts/', PageCursorURL<UnassignedshiftListResponse>, {
       query,
       ...options,
     });
@@ -35,7 +38,7 @@ export class Unassignedshifts extends APIResource {
     body: UnassignedshiftCreateParams,
     options?: RequestOptions,
   ): APIPromise<UnassignedshiftCreateResponse> {
-    return this._client.post('/unassignedshifts', { body, ...options });
+    return this._client.post('/unassignedshifts/', { body, ...options });
   }
 
   /**
@@ -46,7 +49,7 @@ export class Unassignedshifts extends APIResource {
     query: UnassignedshiftRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<UnassignedshiftRetrieveResponse> {
-    return this._client.get(path`/unassignedshifts/${id}`, { query, ...options });
+    return this._client.get(path`/unassignedshifts/${id}/`, { query, ...options });
   }
 
   /**
@@ -57,7 +60,7 @@ export class Unassignedshifts extends APIResource {
     body: UnassignedshiftUpdateParams,
     options?: RequestOptions,
   ): APIPromise<UnassignedshiftUpdateResponse> {
-    return this._client.patch(path`/unassignedshifts/${id}`, { body, ...options });
+    return this._client.patch(path`/unassignedshifts/${id}/`, { body, ...options });
   }
 }
 

package/src/resources/users.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Users of the company
+ */
 export class Users extends APIResource {
   /**
    * A List of users
@@ -19,14 +22,14 @@ export class Users extends APIResource {
     query: UserListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<UsersPageCursorURL, User> {
-    return this._client.getAPIList('/users', PageCursorURL<User>, { query, ...options });
+    return this._client.getAPIList('/users/', PageCursorURL<User>, { query, ...options });
   }
 
   /**
    * Retrieve a specific user
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<UserRetrieveResponse> {
-    return this._client.get(path`/users/${id}`, options);
+    return this._client.get(path`/users/${id}/`, options);
   }
 }
 

package/src/resources/work-locations.ts

@@ -5,9 +5,13 @@ import * as BusinessPartnersAPI from './business-partners';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { PageCursorURL, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Work locations used by the company
+ */
 export class WorkLocations extends APIResource {
   /**
    * A List of work locations
@@ -19,28 +23,38 @@ export class WorkLocations extends APIResource {
     query: WorkLocationListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<WorkLocationsPageCursorURL, WorkLocation> {
-    return this._client.getAPIList('/work-locations', PageCursorURL<WorkLocation>, { query, ...options });
+    return this._client.getAPIList('/work-locations/', PageCursorURL<WorkLocation>, { query, ...options });
   }
 
   /**
    * Create a new work location
    */
   create(body: WorkLocationCreateParams, options?: RequestOptions): APIPromise<WorkLocation> {
-    return this._client.post('/work-locations', { body, ...options });
+    return this._client.post('/work-locations/', { body, ...options });
   }
 
   /**
    * Retrieve a specific work location
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<WorkLocationRetrieveResponse> {
-    return this._client.get(path`/work-locations/${id}`, options);
+    return this._client.get(path`/work-locations/${id}/`, options);
   }
 
   /**
    * Updated a specific work location
    */
   update(id: string, body: WorkLocationUpdateParams, options?: RequestOptions): APIPromise<WorkLocation> {
-    return this._client.patch(path`/work-locations/${id}`, { body, ...options });
+    return this._client.patch(path`/work-locations/${id}/`, { body, ...options });
+  }
+
+  /**
+   * Delete a work location
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/work-locations/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
   }
 }
 

package/src/resources/workers.ts

@@ -14,6 +14,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Workers who work or have worked at the company
+ */
 export class Workers extends APIResource {
   /**
    * A List of workers
@@ -30,7 +33,7 @@ export class Workers extends APIResource {
     query: WorkerListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<WorkersPageCursorURL, Worker> {
-    return this._client.getAPIList('/workers', PageCursorURL<Worker>, { query, ...options });
+    return this._client.getAPIList('/workers/', PageCursorURL<Worker>, { query, ...options });
   }
 
   /**
@@ -41,7 +44,7 @@ export class Workers extends APIResource {
     query: WorkerRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<WorkerRetrieveResponse> {
-    return this._client.get(path`/workers/${id}`, { query, ...options });
+    return this._client.get(path`/workers/${id}/`, { query, ...options });
   }
 }
 
@@ -64,14 +67,18 @@ export interface Worker {
   updated_at: string;
 
   /**
-   * Worker's assigned business partners
+   * Worker's assigned business partners. This field is only populated when
+   * explicitly requested via the expand parameter (e.g., ?expand=business_partners).
+   * When expanded, returns an empty list ([]) if the worker has no business
+   * partners.
    *
    * Expandable field
    */
   business_partners?: Array<BusinessPartnersAPI.BusinessPartner>;
 
   /**
-   * Worker's assigned business partners unique identifiers
+   * Worker's assigned business partners unique identifiers. Returns an empty list
+   * ([]) if the worker has no business partners.
    */
   business_partners_id?: Array<string>;
 
@@ -599,7 +606,7 @@ export interface Worker {
   country_fields?: Worker.CountryFields;
 
   /**
-   * Custom fields for the worker
+   * Custom field values defined on the Employee object for this worker
    *
    * Expandable field
    */
@@ -650,6 +657,7 @@ export interface Worker {
     | 'ASIAN'
     | 'AMERICAN_INDIAN_OR_ALASKA_NATIVE'
     | 'TWO_OR_MORE_RACES'
+    | 'MIDDLE_EASTERN_OR_NORTH_AFRICAN'
     | 'DECLINE_TO_SELF_IDENTIFY'
     | 'AFRICAN'
     | 'COLOURED'

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.26";
+export declare const VERSION = "0.2.0-alpha.28";
 //# 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.26'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.28'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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