feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 7
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-rankincodes%2Fwarp-hr-17b940414060481288221d15ba623ae2a68160a1abde282b216733181ceaa628.yml
-openapi_spec_hash: df1af360b4dcfb59793b9c9c1dcfd07b
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-rankincodes%2Fwarp-hr-19dde65e367945e7a9d0ec732df6ffbe7d23ef2ea7fe88903351b52197632d93.yml
+openapi_spec_hash: b89ec84365c1220afc9c3a657b0228e4
 config_hash: 599b918a4e5ce29219da642bbdf6e191

src/resources/time-off/policies.ts

@@ -7,10 +7,16 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Policies extends APIResource {
+  /**
+   * Get a specific time off policy by id
+   */
   retrieve(id: string, options?: RequestOptions): APIPromise<PolicyRetrieveResponse> {
     return this._client.get(path`/v1/time_off/policies/${id}`, options);
   }
 
+  /**
+   * Get the time off policies for your company
+   */
   list(
     query: PolicyListParams | null | undefined = {},
     options?: RequestOptions,
@@ -25,6 +31,9 @@ export class Policies extends APIResource {
 export type PolicyListResponsesCursorPage = CursorPage<PolicyListResponse>;
 
 export interface PolicyRetrieveResponse {
+  /**
+   * a string starting with "top\_"
+   */
   id: string;
 
   description: string | null;
@@ -43,6 +52,9 @@ export interface PolicyRetrieveResponse {
 
   schedule: 'per_hour_worked' | 'monthly' | 'yearly' | 'unlimited';
 
+  /**
+   * a string starting with "tot\_"
+   */
   timeOffTypeId: string;
 
   timeOffTypeName: string;
@@ -51,6 +63,9 @@ export interface PolicyRetrieveResponse {
 }
 
 export interface PolicyListResponse {
+  /**
+   * a string starting with "top\_"
+   */
   id: string;
 
   description: string | null;
@@ -69,6 +84,9 @@ export interface PolicyListResponse {
 
   schedule: 'per_hour_worked' | 'monthly' | 'yearly' | 'unlimited';
 
+  /**
+   * a string starting with "tot\_"
+   */
   timeOffTypeId: string;
 
   timeOffTypeName: string;

src/resources/time-off/time-off.ts

@@ -15,6 +15,11 @@ import { RequestOptions } from '../../internal/request-options';
 export class TimeOff extends APIResource {
   policies: PoliciesAPI.Policies = new PoliciesAPI.Policies(this._client);
 
+  /**
+   * Time off assignments are mappings between workers and time off policies. Useful
+   * for finding out which policies a worker is assigned to, or which workers are
+   * assigned to a given policy.
+   */
   listAssignments(
     query: TimeOffListAssignmentsParams | null | undefined = {},
     options?: RequestOptions,
@@ -25,6 +30,9 @@ export class TimeOff extends APIResource {
     });
   }
 
+  /**
+   * Get worker remaining time-off balances.
+   */
   listBalances(
     query: TimeOffListBalancesParams | null | undefined = {},
     options?: RequestOptions,
@@ -35,6 +43,9 @@ export class TimeOff extends APIResource {
     });
   }
 
+  /**
+   * Get the time off requests that workers in your company have made.
+   */
   listRequests(
     query: TimeOffListRequestsParams | null | undefined = {},
     options?: RequestOptions,
@@ -60,6 +71,9 @@ export interface TimeOffListAssignmentsResponse {
    */
   assignedAt: string;
 
+  /**
+   * a string starting with "top\_"
+   */
   policyId: string;
 
   /**
@@ -81,6 +95,9 @@ export interface TimeOffListBalancesResponse {
 
   legacyWorkerId: string;
 
+  /**
+   * a string starting with "top\_"
+   */
   policyId: string;
 
   used: number;
@@ -110,6 +127,9 @@ export interface TimeOffListRequestsResponse {
 
   status: 'pending' | 'approved' | 'denied';
 
+  /**
+   * a string starting with "top\_"
+   */
   timeOffPolicyId: string;
 
   /**

src/resources/workers.ts

@@ -7,10 +7,16 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Workers extends APIResource {
+  /**
+   * Get a specific worker by id.
+   */
   retrieve(id: string, options?: RequestOptions): APIPromise<WorkerRetrieveResponse> {
     return this._client.get(path`/v1/workers/${id}`, options);
   }
 
+  /**
+   * List all workers. Workers includ
+   */
   list(
     query: WorkerListParams | null | undefined = {},
     options?: RequestOptions,

tests/api-resources/time-off/policies.test.ts

@@ -10,7 +10,7 @@ const client = new WarpHr({
 describe('resource policies', () => {
   // Prism tests are disabled
   test.skip('retrieve', async () => {
-    const responsePromise = client.timeOff.policies.retrieve('id');
+    const responsePromise = client.timeOff.policies.retrieve('top_1234');
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -37,7 +37,7 @@ describe('resource policies', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       client.timeOff.policies.list(
-        { afterId: 'afterId', beforeId: 'beforeId', limit: 'limit' },
+        { afterId: 'top_1234', beforeId: 'top_1234', limit: 'limit' },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(WarpHr.NotFoundError);

tests/api-resources/time-off/time-off.test.ts

@@ -29,7 +29,7 @@ describe('resource timeOff', () => {
           afterId: 'afterId',
           beforeId: 'beforeId',
           limit: 'limit',
-          policyIds: ['string'],
+          policyIds: ['top_1234'],
           workerIds: ['wrk_1234'],
         },
         { path: '/_stainless_unknown_path' },
@@ -59,7 +59,7 @@ describe('resource timeOff', () => {
           beforeId: 'beforeId',
           endDate: 'endDate',
           limit: 'limit',
-          policyIds: ['string'],
+          policyIds: ['top_1234'],
           startDate: 'startDate',
           workerIds: ['wrk_1234'],
         },
@@ -91,7 +91,7 @@ describe('resource timeOff', () => {
           endsBefore: 'endsBefore',
           endsOnOrAfter: 'endsOnOrAfter',
           limit: 'limit',
-          policyIds: ['string'],
+          policyIds: ['top_1234'],
           startsBefore: 'startsBefore',
           startsOnOrAfter: 'startsOnOrAfter',
           statuses: ['pending'],