@rippling/rippling-sdk 0.2.0-alpha.20

package/src/internal/utils/path.ts

@@ -0,0 +1,88 @@
+import { RipplingSDKError } from '../../core/error';
+
+/**
+ * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
+ *
+ * Taken from https://datatracker.ietf.org/doc/html/rfc3986#section-3.3:
+ * > unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
+ * > sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+ * > pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
+ */
+export function encodeURIPath(str: string) {
+  return str.replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/g, encodeURIComponent);
+}
+
+const EMPTY = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.create(null));
+
+export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
+  function path(statics: readonly string[], ...params: readonly unknown[]): string {
+    // If there are no params, no processing is needed.
+    if (statics.length === 1) return statics[0]!;
+
+    let postPath = false;
+    const invalidSegments = [];
+    const path = statics.reduce((previousValue, currentValue, index) => {
+      if (/[?#]/.test(currentValue)) {
+        postPath = true;
+      }
+      const value = params[index];
+      let encoded = (postPath ? encodeURIComponent : pathEncoder)('' + value);
+      if (
+        index !== params.length &&
+        (value == null ||
+          (typeof value === 'object' &&
+            // handle values from other realms
+            value.toString ===
+              Object.getPrototypeOf(Object.getPrototypeOf((value as any).hasOwnProperty ?? EMPTY) ?? EMPTY)
+                ?.toString))
+      ) {
+        encoded = value + '';
+        invalidSegments.push({
+          start: previousValue.length + currentValue.length,
+          length: encoded.length,
+          error: `Value of type ${Object.prototype.toString
+            .call(value)
+            .slice(8, -1)} is not a valid path parameter`,
+        });
+      }
+      return previousValue + currentValue + (index === params.length ? '' : encoded);
+    }, '');
+
+    const pathOnly = path.split(/[?#]/, 1)[0]!;
+    const invalidSegmentPattern = /(?<=^|\/)(?:\.|%2e){1,2}(?=\/|$)/gi;
+    let match;
+
+    // Find all invalid segments
+    while ((match = invalidSegmentPattern.exec(pathOnly)) !== null) {
+      invalidSegments.push({
+        start: match.index,
+        length: match[0].length,
+        error: `Value "${match[0]}" can\'t be safely passed as a path parameter`,
+      });
+    }
+
+    invalidSegments.sort((a, b) => a.start - b.start);
+
+    if (invalidSegments.length > 0) {
+      let lastEnd = 0;
+      const underline = invalidSegments.reduce((acc, segment) => {
+        const spaces = ' '.repeat(segment.start - lastEnd);
+        const arrows = '^'.repeat(segment.length);
+        lastEnd = segment.start + segment.length;
+        return acc + spaces + arrows;
+      }, '');
+
+      throw new RipplingSDKError(
+        `Path parameters result in path with invalid segments:\n${invalidSegments
+          .map((e) => e.error)
+          .join('\n')}\n${path}\n${underline}`,
+      );
+    }
+
+    return path;
+  };
+
+/**
+ * URI-encodes path params and ensures no unsafe /./ or /../ path segments are introduced.
+ */
+export const path = /* @__PURE__ */ createPathTagFunction(encodeURIPath);

package/src/internal/utils/sleep.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export const sleep = (ms: number) => new Promise<void>((resolve) => setTimeout(resolve, ms));

package/src/internal/utils/uuid.ts

@@ -0,0 +1,17 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+/**
+ * https://stackoverflow.com/a/2117523
+ */
+export let uuid4 = function () {
+  const { crypto } = globalThis as any;
+  if (crypto?.randomUUID) {
+    uuid4 = crypto.randomUUID.bind(crypto);
+    return crypto.randomUUID();
+  }
+  const u8 = new Uint8Array(1);
+  const randomByte = crypto ? () => crypto.getRandomValues(u8)[0]! : () => (Math.random() * 0xff) & 0xff;
+  return '10000000-1000-4000-8000-100000000000'.replace(/[018]/g, (c) =>
+    (+c ^ (randomByte() & (15 >> (+c / 4)))).toString(16),
+  );
+};

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { RipplingSDKError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new RipplingSDKError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new RipplingSDKError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new RipplingSDKError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new RipplingSDKError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new RipplingSDKError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value === undefined) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value === undefined) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value === undefined) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/pagination.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/pagination instead */
+export * from './core/pagination';

package/src/resource.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

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

@@ -0,0 +1,146 @@
+// 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 { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class BusinessPartnerGroups extends APIResource {
+  /**
+   * Create a new business partner group
+   */
+  create(body: BusinessPartnerGroupCreateParams, options?: RequestOptions): APIPromise<BusinessPartnerGroup> {
+    return this._client.post('/business-partner-groups', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific business partner group
+   */
+  retrieve(
+    id: string,
+    query: BusinessPartnerGroupRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BusinessPartnerGroupRetrieveResponse> {
+    return this._client.get(path`/business-partner-groups/${id}`, { query, ...options });
+  }
+
+  /**
+   * A List of business partner groups
+   *
+   * - Requires: `API Tier 1`
+   * - Expandable fields: `default_business_partner`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: BusinessPartnerGroupListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BusinessPartnerGroupsPageCursorURL, BusinessPartnerGroup> {
+    return this._client.getAPIList('/business-partner-groups', PageCursorURL<BusinessPartnerGroup>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete a business partner group
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/business-partner-groups/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type BusinessPartnerGroupsPageCursorURL = PageCursorURL<BusinessPartnerGroup>;
+
+export interface BusinessPartnerGroup {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Name used to identify business partner group
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Optional default business partner worker to whom all employees will be mapped if
+   * not explicitly mapped to a business partner in the group.
+   *
+   * Expandable field
+   */
+  default_business_partner?: WorkersAPI.Worker;
+
+  /**
+   * Id of Optional default business partner worker to whom all employees will be
+   * mapped if not explicitly mapped to a business partner in the group.
+   */
+  default_business_partner_id?: string;
+
+  /**
+   * Type of business partner group
+   */
+  domain?: 'HR' | 'IT' | 'FINANCE' | 'RECRUITING' | 'OTHER';
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface BusinessPartnerGroupRetrieveResponse
+  extends BusinessPartnersAPI.Meta,
+    BusinessPartnerGroup {}
+
+export interface BusinessPartnerGroupCreateParams {
+  /**
+   * Name used to identify business partner group
+   */
+  name: string;
+
+  /**
+   * Id of Optional default business partner worker to whom all employees will be
+   * mapped if not explicitly mapped to a business partner in the group.
+   */
+  default_business_partner_id?: string;
+
+  /**
+   * Type of business partner group
+   */
+  domain?: 'HR' | 'IT' | 'FINANCE' | 'RECRUITING' | 'OTHER';
+}
+
+export interface BusinessPartnerGroupRetrieveParams {
+  expand?: string;
+}
+
+export interface BusinessPartnerGroupListParams {
+  expand?: string;
+
+  order_by?: string;
+}
+
+export declare namespace BusinessPartnerGroups {
+  export {
+    type BusinessPartnerGroup as BusinessPartnerGroup,
+    type BusinessPartnerGroupRetrieveResponse as BusinessPartnerGroupRetrieveResponse,
+    type BusinessPartnerGroupsPageCursorURL as BusinessPartnerGroupsPageCursorURL,
+    type BusinessPartnerGroupCreateParams as BusinessPartnerGroupCreateParams,
+    type BusinessPartnerGroupRetrieveParams as BusinessPartnerGroupRetrieveParams,
+    type BusinessPartnerGroupListParams as BusinessPartnerGroupListParams,
+  };
+}

package/src/resources/business-partners.ts

@@ -0,0 +1,190 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnerGroupsAPI from './business-partner-groups';
+import * as WorkersAPI from './workers';
+import * as SupergroupsAPI from './supergroups/supergroups';
+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 BusinessPartners extends APIResource {
+  /**
+   * Create a new business partner
+   */
+  create(body: BusinessPartnerCreateParams, options?: RequestOptions): APIPromise<BusinessPartner> {
+    return this._client.post('/business-partners', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific business partner
+   */
+  retrieve(
+    id: string,
+    query: BusinessPartnerRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BusinessPartnerRetrieveResponse> {
+    return this._client.get(path`/business-partners/${id}`, { query, ...options });
+  }
+
+  /**
+   * A List of business partners
+   *
+   * - Requires: `API Tier 1`
+   * - Filterable fields: `worker_id`, `business_partner_group_id`
+   * - Expandable fields: `business_partner_group`, `worker`, `client_group`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: BusinessPartnerListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BusinessPartnersPageCursorURL, BusinessPartner> {
+    return this._client.getAPIList('/business-partners', PageCursorURL<BusinessPartner>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete a business partner
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/business-partners/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type BusinessPartnersPageCursorURL = PageCursorURL<BusinessPartner>;
+
+export interface BusinessPartner {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Identifier of business partner group the business parter is a part of
+   */
+  business_partner_group_id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Identifier of worker who is the business partner
+   */
+  worker_id: string;
+
+  /**
+   * Business partner group the business partner is a part of
+   *
+   * Expandable field
+   */
+  business_partner_group?: BusinessPartnerGroupsAPI.BusinessPartnerGroup;
+
+  /**
+   * Group of workers associated with the business partner
+   *
+   * Expandable field
+   */
+  client_group?: SupergroupsAPI.Supergroup;
+
+  /**
+   * Identifier of group of workers associated with the business partner
+   */
+  client_group_id?: string;
+
+  /**
+   * Number of workers associated with the business partner
+   */
+  client_group_member_count?: number;
+
+  /**
+   * Worker who is the business partner
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface Meta {
+  __meta?: Meta._Meta;
+}
+
+export namespace Meta {
+  export interface _Meta {
+    redacted_fields?: Array<_Meta.RedactedField>;
+  }
+
+  export namespace _Meta {
+    /**
+     * Info about the redacted fields.
+     */
+    export interface RedactedField {
+      /**
+       * The name for the redacted field
+       */
+      name?: string;
+
+      /**
+       * The reason for the redaction
+       */
+      reason?: string;
+    }
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface BusinessPartnerRetrieveResponse extends Meta, BusinessPartner {}
+
+export interface BusinessPartnerCreateParams {
+  /**
+   * Identifier of business partner group the business parter is a part of
+   */
+  business_partner_group_id: string;
+
+  /**
+   * Identifier of worker who is the business partner
+   */
+  worker_id: string;
+}
+
+export interface BusinessPartnerRetrieveParams {
+  expand?: string;
+}
+
+export interface BusinessPartnerListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export declare namespace BusinessPartners {
+  export {
+    type BusinessPartner as BusinessPartner,
+    type Meta as Meta,
+    type BusinessPartnerRetrieveResponse as BusinessPartnerRetrieveResponse,
+    type BusinessPartnersPageCursorURL as BusinessPartnersPageCursorURL,
+    type BusinessPartnerCreateParams as BusinessPartnerCreateParams,
+    type BusinessPartnerRetrieveParams as BusinessPartnerRetrieveParams,
+    type BusinessPartnerListParams as BusinessPartnerListParams,
+  };
+}

package/src/resources/candidate-applications.ts

@@ -0,0 +1,91 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as JobRequisitionsAPI from './job-requisitions';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+export class CandidateApplications extends APIResource {
+  /**
+   * A List of candidate applications
+   *
+   * - Requires: `API Tier 2`
+   * - Expandable fields: `job`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: CandidateApplicationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CandidateApplicationListResponsesPageCursorURL, CandidateApplicationListResponse> {
+    return this._client.getAPIList(
+      '/candidate-applications',
+      PageCursorURL<CandidateApplicationListResponse>,
+      { query, ...options },
+    );
+  }
+}
+
+export type CandidateApplicationListResponsesPageCursorURL = PageCursorURL<CandidateApplicationListResponse>;
+
+export interface CandidateApplicationListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Application creation date
+   */
+  applied_at?: string;
+
+  /**
+   * Job requisition
+   *
+   * Expandable field
+   */
+  job?: JobRequisitionsAPI.JobRequisition;
+
+  /**
+   * Job requisition ID
+   */
+  job_id?: string;
+
+  /**
+   * Application stage
+   */
+  stage?: string;
+
+  /**
+   * Application status
+   */
+  status?: 'ACTIVE' | 'REJECTED' | 'HIRED' | 'ARCHIVED';
+
+  /**
+   * Application url
+   */
+  url?: string;
+}
+
+export interface CandidateApplicationListParams {
+  expand?: string;
+
+  order_by?: string;
+}
+
+export declare namespace CandidateApplications {
+  export {
+    type CandidateApplicationListResponse as CandidateApplicationListResponse,
+    type CandidateApplicationListResponsesPageCursorURL as CandidateApplicationListResponsesPageCursorURL,
+    type CandidateApplicationListParams as CandidateApplicationListParams,
+  };
+}