@rippling/rippling-sdk 0.2.0-alpha.25 → 0.2.0-alpha.27

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
@@ -22,12 +26,36 @@ export class WorkLocations extends APIResource {
     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 });
+  }
+
   /**
    * Retrieve a specific work location
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<WorkLocationRetrieveResponse> {
     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 });
+  }
+
+  /**
+   * 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]),
+    });
+  }
 }
 
 export type WorkLocationsPageCursorURL = PageCursorURL<WorkLocation>;
@@ -70,11 +98,115 @@ export interface WorkLocationListParams {
   order_by?: string;
 }
 
+export interface WorkLocationCreateParams {
+  /**
+   * The address for the work location.
+   */
+  address: WorkLocationCreateParams.Address;
+
+  /**
+   * The name of the work location.
+   */
+  name: string;
+}
+
+export namespace WorkLocationCreateParams {
+  /**
+   * The address for the work location.
+   */
+  export interface Address {
+    /**
+     * The country component, pursuant to SCIM RFC 7643 4.1.2.
+     */
+    country?: Shared.CountryCode;
+
+    /**
+     * The city or locality component.
+     */
+    locality?: string;
+
+    /**
+     * The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
+     */
+    postal_code?: string;
+
+    /**
+     * The state or region component, pursuant to SCIM RFC 7643 4.1.2.
+     */
+    region?: string;
+
+    /**
+     * The full street address component, which may include house number, street name,
+     * P.O. box, and multi-line extended street address information, pursuant to SCIM
+     * RFC 7643 4.1.2..
+     */
+    street_address?: string;
+
+    /**
+     * The classification of the address.
+     */
+    type?: 'HOME' | 'WORK' | 'OTHER';
+  }
+}
+
+export interface WorkLocationUpdateParams {
+  /**
+   * The address for the work location.
+   */
+  address: WorkLocationUpdateParams.Address;
+
+  /**
+   * The name of the work location.
+   */
+  name: string;
+}
+
+export namespace WorkLocationUpdateParams {
+  /**
+   * The address for the work location.
+   */
+  export interface Address {
+    /**
+     * The country component, pursuant to SCIM RFC 7643 4.1.2.
+     */
+    country?: Shared.CountryCode;
+
+    /**
+     * The city or locality component.
+     */
+    locality?: string;
+
+    /**
+     * The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
+     */
+    postal_code?: string;
+
+    /**
+     * The state or region component, pursuant to SCIM RFC 7643 4.1.2.
+     */
+    region?: string;
+
+    /**
+     * The full street address component, which may include house number, street name,
+     * P.O. box, and multi-line extended street address information, pursuant to SCIM
+     * RFC 7643 4.1.2..
+     */
+    street_address?: string;
+
+    /**
+     * The classification of the address.
+     */
+    type?: 'HOME' | 'WORK' | 'OTHER';
+  }
+}
+
 export declare namespace WorkLocations {
   export {
     type WorkLocation as WorkLocation,
     type WorkLocationRetrieveResponse as WorkLocationRetrieveResponse,
     type WorkLocationsPageCursorURL as WorkLocationsPageCursorURL,
     type WorkLocationListParams as WorkLocationListParams,
+    type WorkLocationCreateParams as WorkLocationCreateParams,
+    type WorkLocationUpdateParams as WorkLocationUpdateParams,
   };
 }

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
@@ -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.25'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.27'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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