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

package/src/functions.ts

@@ -118,3 +118,17 @@ export interface DataBridgeRequest {
     connectionId: string;
   };
 }
+
+export class DataBridgeRateLimitError extends Error {
+  waitTimeInSeconds: number;
+  constructor(message: string, waitTimeInSeconds: number) {
+    const jsonMessage = JSON.stringify({
+      message,
+      waitTimeInSeconds,
+    });
+
+    super(jsonMessage);
+    this.name = 'RateLimitError';
+    this.waitTimeInSeconds = waitTimeInSeconds;
+  }
+}

package/src/internal/parse.ts

@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: RipplingSDK, props: APIRes
     const mediaType = contentType?.split(';')[0]?.trim();
     const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
     if (isJSON) {
+      const contentLength = response.headers.get('content-length');
+      if (contentLength === '0') {
+        // if there is no content we can't do anything
+        return undefined as T;
+      }
+
       const json = await response.json();
       return json as T;
     }

package/src/internal/utils/query.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { RipplingSDKError } from '../../core/error';
+
+/**
+ * Basic re-implementation of `qs.stringify` for primitive types.
+ */
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return Object.entries(query)
+    .filter(([_, value]) => typeof value !== 'undefined')
+    .map(([key, value]) => {
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+      }
+      if (value === null) {
+        return `${encodeURIComponent(key)}=`;
+      }
+      throw new RipplingSDKError(
+        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+      );
+    })
+    .join('&');
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/business-partner-groups.ts

@@ -9,6 +9,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Business partners of the company
+ */
 export class BusinessPartnerGroups extends APIResource {
   /**
    * A List of business partner groups

package/src/resources/business-partners.ts

@@ -10,6 +10,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Business partners of the company
+ */
 export class BusinessPartners extends APIResource {
   /**
    * A List of business partners

package/src/resources/candidate-applications.ts

@@ -5,6 +5,9 @@ import * as JobRequisitionsAPI from './job-requisitions';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * An application by a candidate to a specific job requisition
+ */
 export class CandidateApplications extends APIResource {
   /**
    * A List of candidate applications

package/src/resources/candidates.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Someone who applies to a job requisition opened by the company
+ */
 export class Candidates extends APIResource {
   /**
    * A List of candidates

package/src/resources/companies.ts

@@ -6,6 +6,9 @@ import * as Shared from './shared';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Companies on Rippling
+ */
 export class Companies extends APIResource {
   /**
    * A List of companies

package/src/resources/compensation-bands-details.ts

@@ -0,0 +1,143 @@
+// 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 * as WorkersAPI from './workers';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Compensation bands details associated with workers
+ */
+export class CompensationBandsDetails extends APIResource {
+  /**
+   * A List of compensation bands details
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `created_at`, `updated_at`, `internal_job_code`,
+   *   `worker_id`
+   * - Expandable fields: `worker`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: CompensationBandsDetailListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CompensationBandsDetailListResponsesPageCursorURL, CompensationBandsDetailListResponse> {
+    return this._client.getAPIList(
+      '/compensation-bands-details',
+      PageCursorURL<CompensationBandsDetailListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Retrieve a specific compensation bands detail
+   */
+  retrieve(
+    id: string,
+    query: CompensationBandsDetailRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CompensationBandsDetailRetrieveResponse> {
+    return this._client.get(path`/compensation-bands-details/${id}`, { query, ...options });
+  }
+}
+
+export type CompensationBandsDetailListResponsesPageCursorURL =
+  PageCursorURL<CompensationBandsDetailListResponse>;
+
+export interface CompensationBandsDetailListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Internal job code
+   */
+  internal_job_code?: string;
+
+  /**
+   * The worker associated with compensation bands
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * ID of the worker associated with compensation bands
+   */
+  worker_id?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface CompensationBandsDetailRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Internal job code
+   */
+  internal_job_code?: string;
+
+  /**
+   * The worker associated with compensation bands
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * ID of the worker associated with compensation bands
+   */
+  worker_id?: string;
+}
+
+export interface CompensationBandsDetailListParams {
+  cursor?: string;
+
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface CompensationBandsDetailRetrieveParams {
+  expand?: string;
+}
+
+export declare namespace CompensationBandsDetails {
+  export {
+    type CompensationBandsDetailListResponse as CompensationBandsDetailListResponse,
+    type CompensationBandsDetailRetrieveResponse as CompensationBandsDetailRetrieveResponse,
+    type CompensationBandsDetailListResponsesPageCursorURL as CompensationBandsDetailListResponsesPageCursorURL,
+    type CompensationBandsDetailListParams as CompensationBandsDetailListParams,
+    type CompensationBandsDetailRetrieveParams as CompensationBandsDetailRetrieveParams,
+  };
+}

package/src/resources/compensations.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Compensation associated with workers
+ */
 export class Compensations extends APIResource {
   /**
    * A List of compensations

package/src/resources/create-app-notification.ts

@@ -0,0 +1,46 @@
+// 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';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class CreateAppNotification extends APIResource {
+  /**
+   * Create an in-app notification for the specified recipients.
+   */
+  create(
+    body: CreateAppNotificationCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<CreateAppNotificationCreateResponse> {
+    return this._client.post('/create-app-notification', { body, ...options });
+  }
+}
+
+export interface CreateAppNotificationCreateResponse {
+  /**
+   * Result of the create app notification action
+   */
+  result: unknown;
+}
+
+export interface CreateAppNotificationCreateParams {
+  description: string;
+
+  recipients: Array<string>;
+
+  subject: string;
+
+  days_from_now?: number | null;
+
+  due_date?: string | null;
+}
+
+export declare namespace CreateAppNotification {
+  export {
+    type CreateAppNotificationCreateResponse as CreateAppNotificationCreateResponse,
+    type CreateAppNotificationCreateParams as CreateAppNotificationCreateParams,
+  };
+}

package/src/resources/custom-apps.ts

@@ -0,0 +1,342 @@
+// 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 { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class CustomApps extends APIResource {
+  /**
+   * A List of CustomApp
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<CustomAppListResponsesPageCursorURL, CustomAppListResponse> {
+    return this._client.getAPIList('/custom-apps', PageCursorURL<CustomAppListResponse>, options);
+  }
+
+  /**
+   * Create a new CustomApp
+   */
+  create(body: CustomAppCreateParams, options?: RequestOptions): APIPromise<CustomAppCreateResponse> {
+    return this._client.post('/custom-apps', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific CustomApp
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<CustomAppRetrieveResponse> {
+    return this._client.get(path`/custom-apps/${id}`, options);
+  }
+
+  /**
+   * Updated a specific CustomApp
+   */
+  update(
+    id: string,
+    body: CustomAppUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomAppUpdateResponse> {
+    return this._client.patch(path`/custom-apps/${id}`, { body, ...options });
+  }
+
+  /**
+   * Delete a CustomApp
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/custom-apps/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type CustomAppListResponsesPageCursorURL = PageCursorURL<CustomAppListResponse>;
+
+export interface CustomAppListResponse {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+
+  /**
+   * The icon URL of the custom app
+   */
+  icon?: string;
+
+  /**
+   * The pages of the custom app
+   */
+  pages?: Array<CustomAppListResponse.Page>;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+}
+
+export namespace CustomAppListResponse {
+  /**
+   * Summary of a page attached to a custom app.
+   */
+  export interface Page {
+    /**
+     * The unique name of the page within the app
+     */
+    api_name?: string;
+
+    /**
+     * The ID of the canvas instance backing this page
+     */
+    canvas_instance_id?: string;
+  }
+}
+
+export interface CustomAppCreateResponse {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+
+  /**
+   * The icon URL of the custom app
+   */
+  icon?: string;
+
+  /**
+   * The pages of the custom app
+   */
+  pages?: Array<CustomAppCreateResponse.Page>;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+}
+
+export namespace CustomAppCreateResponse {
+  /**
+   * Summary of a page attached to a custom app.
+   */
+  export interface Page {
+    /**
+     * The unique name of the page within the app
+     */
+    api_name?: string;
+
+    /**
+     * The ID of the canvas instance backing this page
+     */
+    canvas_instance_id?: string;
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface CustomAppRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+
+  /**
+   * The icon URL of the custom app
+   */
+  icon?: string;
+
+  /**
+   * The pages of the custom app
+   */
+  pages?: Array<CustomAppRetrieveResponse.Page>;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+}
+
+export namespace CustomAppRetrieveResponse {
+  /**
+   * Summary of a page attached to a custom app.
+   */
+  export interface Page {
+    /**
+     * The unique name of the page within the app
+     */
+    api_name?: string;
+
+    /**
+     * The ID of the canvas instance backing this page
+     */
+    canvas_instance_id?: string;
+  }
+}
+
+export interface CustomAppUpdateResponse {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+
+  /**
+   * The icon URL of the custom app
+   */
+  icon?: string;
+
+  /**
+   * The pages of the custom app
+   */
+  pages?: Array<CustomAppUpdateResponse.Page>;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+}
+
+export namespace CustomAppUpdateResponse {
+  /**
+   * Summary of a page attached to a custom app.
+   */
+  export interface Page {
+    /**
+     * The unique name of the page within the app
+     */
+    api_name?: string;
+
+    /**
+     * The ID of the canvas instance backing this page
+     */
+    canvas_instance_id?: string;
+  }
+}
+
+export interface CustomAppCreateParams {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+}
+
+export interface CustomAppUpdateParams {
+  /**
+   * The unique api name of the custom app
+   */
+  api_name: string;
+
+  /**
+   * The display name of the custom app
+   */
+  name: string;
+
+  /**
+   * The description of the custom app
+   */
+  description?: string;
+}
+
+export declare namespace CustomApps {
+  export {
+    type CustomAppListResponse as CustomAppListResponse,
+    type CustomAppCreateResponse as CustomAppCreateResponse,
+    type CustomAppRetrieveResponse as CustomAppRetrieveResponse,
+    type CustomAppUpdateResponse as CustomAppUpdateResponse,
+    type CustomAppListResponsesPageCursorURL as CustomAppListResponsesPageCursorURL,
+    type CustomAppCreateParams as CustomAppCreateParams,
+    type CustomAppUpdateParams as CustomAppUpdateParams,
+  };
+}

package/src/resources/custom-fields.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Custom fields defined by the company
+ */
 export class CustomFields extends APIResource {
   /**
    * A List of custom fields

package/src/resources/custom-objects/custom-objects.ts

@@ -32,6 +32,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Custom objects defined by the company
+ */
 export class CustomObjects extends APIResource {
   fields: FieldsAPI.Fields = new FieldsAPI.Fields(this._client);
   records: RecordsAPI.Records = new RecordsAPI.Records(this._client);

package/src/resources/custom-objects/fields.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Custom object fields defined by the company
+ */
 export class Fields extends APIResource {
   /**
    * A List of custom object fields

package/src/resources/custom-objects/records.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Custom object datarows defined by the company
+ */
 export class Records extends APIResource {
   /**
    * A List of custom object records