@rippling/rippling-sdk 0.2.0-alpha.97 → 0.2.0-alpha.98

package/src/client.ts

@@ -501,6 +501,7 @@ import {
   SandboxListParams,
   SandboxListResponse,
   SandboxListResponsesPageCursorURL,
+  SandboxRetrieveResponse,
   Sandboxes,
 } from './resources/sandboxes';
 import {
@@ -654,11 +655,41 @@ import {
   Unassignedshifts,
 } from './resources/unassignedshifts';
 import { User, UserListParams, UserRetrieveResponse, Users, UsersPageCursorURL } from './resources/users';
+import {
+  VariableCompensationPayoutLabelCreateParams,
+  VariableCompensationPayoutLabelCreateResponse,
+  VariableCompensationPayoutLabelListParams,
+  VariableCompensationPayoutLabelListResponse,
+  VariableCompensationPayoutLabelListResponsesPageCursorURL,
+  VariableCompensationPayoutLabelRetrieveResponse,
+  VariableCompensationPayoutLabelUpdateParams,
+  VariableCompensationPayoutLabelUpdateResponse,
+  VariableCompensationPayoutLabels,
+} from './resources/variable-compensation-payout-labels';
+import {
+  VariableCompensationPayoutTypeCreateParams,
+  VariableCompensationPayoutTypeCreateResponse,
+  VariableCompensationPayoutTypeListResponse,
+  VariableCompensationPayoutTypeListResponsesPageCursorURL,
+  VariableCompensationPayoutTypeRetrieveResponse,
+  VariableCompensationPayoutTypeUpdateParams,
+  VariableCompensationPayoutTypeUpdateResponse,
+  VariableCompensationPayoutTypes,
+} from './resources/variable-compensation-payout-types';
 import {
   VariableCompensationPayoutWriteCreateParams,
   VariableCompensationPayoutWriteCreateResponse,
   VariableCompensationPayoutWrites,
 } from './resources/variable-compensation-payout-writes';
+import {
+  VariableCompensationPayoutCreateParams,
+  VariableCompensationPayoutCreateResponse,
+  VariableCompensationPayoutListParams,
+  VariableCompensationPayoutListResponse,
+  VariableCompensationPayoutListResponsesPageCursorURL,
+  VariableCompensationPayoutRetrieveResponse,
+  VariableCompensationPayouts,
+} from './resources/variable-compensation-payouts';
 import {
   WorkLocation,
   WorkLocationCreateParams,
@@ -747,7 +778,13 @@ import {
   Functions,
   FunctionsPageCursorURL,
 } from './resources/functions/functions';
-import { Metadata, MetadataExtractParams, MetadataExtractResponse } from './resources/metadata/metadata';
+import {
+  Metadata,
+  MetadataExtractByIdentifiersParams,
+  MetadataExtractByIdentifiersResponse,
+  MetadataExtractParams,
+  MetadataExtractResponse,
+} from './resources/metadata/metadata';
 import {
   PackageVersionRetrieveResponse,
   PackageVersionUpdateParams,
@@ -1854,6 +1891,9 @@ export class RipplingSDK {
    * Shift assignments assigned to workers
    */
   shiftassignments: API.Shiftassignments = new API.Shiftassignments(this);
+  /**
+   * Custom sites hosted on Rippling
+   */
   sites: API.Sites = new API.Sites(this);
   /**
    * Software deployed to company devices
@@ -1867,6 +1907,20 @@ export class RipplingSDK {
    * Unassigned shifts that are part of a schedule
    */
   unassignedshifts: API.Unassignedshifts = new API.Unassignedshifts(this);
+  /**
+   * Compensation associated with workers
+   */
+  variableCompensationPayouts: API.VariableCompensationPayouts = new API.VariableCompensationPayouts(this);
+  /**
+   * Compensation associated with workers
+   */
+  variableCompensationPayoutLabels: API.VariableCompensationPayoutLabels =
+    new API.VariableCompensationPayoutLabels(this);
+  /**
+   * Compensation associated with workers
+   */
+  variableCompensationPayoutTypes: API.VariableCompensationPayoutTypes =
+    new API.VariableCompensationPayoutTypes(this);
   /**
    * Compensation associated with workers
    */
@@ -1994,6 +2048,9 @@ RipplingSDK.Sites = Sites;
 RipplingSDK.SoftwareDeployments = SoftwareDeployments;
 RipplingSDK.Titles = Titles;
 RipplingSDK.Unassignedshifts = Unassignedshifts;
+RipplingSDK.VariableCompensationPayouts = VariableCompensationPayouts;
+RipplingSDK.VariableCompensationPayoutLabels = VariableCompensationPayoutLabels;
+RipplingSDK.VariableCompensationPayoutTypes = VariableCompensationPayoutTypes;
 RipplingSDK.VariableCompensationPayoutWrites = VariableCompensationPayoutWrites;
 RipplingSDK.WorkerChanges = WorkerChanges;
 RipplingSDK.WorkerChangeFields = WorkerChangeFields;
@@ -2727,6 +2784,7 @@ export declare namespace RipplingSDK {
     Sandboxes as Sandboxes,
     type SandboxListResponse as SandboxListResponse,
     type SandboxCreateResponse as SandboxCreateResponse,
+    type SandboxRetrieveResponse as SandboxRetrieveResponse,
     type SandboxDeveloperSandboxEntryRolesResponse as SandboxDeveloperSandboxEntryRolesResponse,
     type SandboxListResponsesPageCursorURL as SandboxListResponsesPageCursorURL,
     type SandboxListParams as SandboxListParams,
@@ -2823,6 +2881,39 @@ export declare namespace RipplingSDK {
     type UnassignedshiftUpdateParams as UnassignedshiftUpdateParams,
   };
 
+  export {
+    VariableCompensationPayouts as VariableCompensationPayouts,
+    type VariableCompensationPayoutListResponse as VariableCompensationPayoutListResponse,
+    type VariableCompensationPayoutCreateResponse as VariableCompensationPayoutCreateResponse,
+    type VariableCompensationPayoutRetrieveResponse as VariableCompensationPayoutRetrieveResponse,
+    type VariableCompensationPayoutListResponsesPageCursorURL as VariableCompensationPayoutListResponsesPageCursorURL,
+    type VariableCompensationPayoutListParams as VariableCompensationPayoutListParams,
+    type VariableCompensationPayoutCreateParams as VariableCompensationPayoutCreateParams,
+  };
+
+  export {
+    VariableCompensationPayoutLabels as VariableCompensationPayoutLabels,
+    type VariableCompensationPayoutLabelListResponse as VariableCompensationPayoutLabelListResponse,
+    type VariableCompensationPayoutLabelCreateResponse as VariableCompensationPayoutLabelCreateResponse,
+    type VariableCompensationPayoutLabelRetrieveResponse as VariableCompensationPayoutLabelRetrieveResponse,
+    type VariableCompensationPayoutLabelUpdateResponse as VariableCompensationPayoutLabelUpdateResponse,
+    type VariableCompensationPayoutLabelListResponsesPageCursorURL as VariableCompensationPayoutLabelListResponsesPageCursorURL,
+    type VariableCompensationPayoutLabelListParams as VariableCompensationPayoutLabelListParams,
+    type VariableCompensationPayoutLabelCreateParams as VariableCompensationPayoutLabelCreateParams,
+    type VariableCompensationPayoutLabelUpdateParams as VariableCompensationPayoutLabelUpdateParams,
+  };
+
+  export {
+    VariableCompensationPayoutTypes as VariableCompensationPayoutTypes,
+    type VariableCompensationPayoutTypeListResponse as VariableCompensationPayoutTypeListResponse,
+    type VariableCompensationPayoutTypeCreateResponse as VariableCompensationPayoutTypeCreateResponse,
+    type VariableCompensationPayoutTypeRetrieveResponse as VariableCompensationPayoutTypeRetrieveResponse,
+    type VariableCompensationPayoutTypeUpdateResponse as VariableCompensationPayoutTypeUpdateResponse,
+    type VariableCompensationPayoutTypeListResponsesPageCursorURL as VariableCompensationPayoutTypeListResponsesPageCursorURL,
+    type VariableCompensationPayoutTypeCreateParams as VariableCompensationPayoutTypeCreateParams,
+    type VariableCompensationPayoutTypeUpdateParams as VariableCompensationPayoutTypeUpdateParams,
+  };
+
   export {
     VariableCompensationPayoutWrites as VariableCompensationPayoutWrites,
     type VariableCompensationPayoutWriteCreateResponse as VariableCompensationPayoutWriteCreateResponse,
@@ -2893,7 +2984,9 @@ export declare namespace RipplingSDK {
   export {
     Metadata as Metadata,
     type MetadataExtractResponse as MetadataExtractResponse,
+    type MetadataExtractByIdentifiersResponse as MetadataExtractByIdentifiersResponse,
     type MetadataExtractParams as MetadataExtractParams,
+    type MetadataExtractByIdentifiersParams as MetadataExtractByIdentifiersParams,
   };
 
   export type Address = API.Address;

package/src/resources/index.ts

@@ -450,7 +450,13 @@ export {
   type LocationFactorListParams,
   type LocationFactorListResponsesPageCursorURL,
 } from './location-factors';
-export { Metadata, type MetadataExtractResponse, type MetadataExtractParams } from './metadata/metadata';
+export {
+  Metadata,
+  type MetadataExtractResponse,
+  type MetadataExtractByIdentifiersResponse,
+  type MetadataExtractParams,
+  type MetadataExtractByIdentifiersParams,
+} from './metadata/metadata';
 export {
   ObjectCategories,
   type ObjectCategory,
@@ -536,6 +542,7 @@ export {
   Sandboxes,
   type SandboxListResponse,
   type SandboxCreateResponse,
+  type SandboxRetrieveResponse,
   type SandboxDeveloperSandboxEntryRolesResponse,
   type SandboxListParams,
   type SandboxCreateParams,
@@ -704,11 +711,41 @@ export {
   type UserListParams,
   type UsersPageCursorURL,
 } from './users';
+export {
+  VariableCompensationPayoutLabels,
+  type VariableCompensationPayoutLabelListResponse,
+  type VariableCompensationPayoutLabelCreateResponse,
+  type VariableCompensationPayoutLabelRetrieveResponse,
+  type VariableCompensationPayoutLabelUpdateResponse,
+  type VariableCompensationPayoutLabelListParams,
+  type VariableCompensationPayoutLabelCreateParams,
+  type VariableCompensationPayoutLabelUpdateParams,
+  type VariableCompensationPayoutLabelListResponsesPageCursorURL,
+} from './variable-compensation-payout-labels';
+export {
+  VariableCompensationPayoutTypes,
+  type VariableCompensationPayoutTypeListResponse,
+  type VariableCompensationPayoutTypeCreateResponse,
+  type VariableCompensationPayoutTypeRetrieveResponse,
+  type VariableCompensationPayoutTypeUpdateResponse,
+  type VariableCompensationPayoutTypeCreateParams,
+  type VariableCompensationPayoutTypeUpdateParams,
+  type VariableCompensationPayoutTypeListResponsesPageCursorURL,
+} from './variable-compensation-payout-types';
 export {
   VariableCompensationPayoutWrites,
   type VariableCompensationPayoutWriteCreateResponse,
   type VariableCompensationPayoutWriteCreateParams,
 } from './variable-compensation-payout-writes';
+export {
+  VariableCompensationPayouts,
+  type VariableCompensationPayoutListResponse,
+  type VariableCompensationPayoutCreateResponse,
+  type VariableCompensationPayoutRetrieveResponse,
+  type VariableCompensationPayoutListParams,
+  type VariableCompensationPayoutCreateParams,
+  type VariableCompensationPayoutListResponsesPageCursorURL,
+} from './variable-compensation-payouts';
 export {
   WorkLocations,
   type WorkLocation,

package/src/resources/metadata/index.ts

@@ -13,7 +13,13 @@ export {
   type DeploymentRunGetResponse,
   type DeploymentRunCreateParams,
 } from './deployment-runs';
-export { Metadata, type MetadataExtractResponse, type MetadataExtractParams } from './metadata';
+export {
+  Metadata,
+  type MetadataExtractResponse,
+  type MetadataExtractByIdentifiersResponse,
+  type MetadataExtractParams,
+  type MetadataExtractByIdentifiersParams,
+} from './metadata';
 export { Schema, type SchemaGetResponse, type SchemaGetParams } from './schema';
 export { Types, type TypeListResponse } from './types';
 export {

package/src/resources/metadata/metadata.ts

@@ -57,6 +57,25 @@ export class Metadata extends APIResource {
   ): APIPromise<MetadataExtractResponse> {
     return this._client.get('/metadata/extract/', { query, ...options });
   }
+
+  /**
+   * Extract exact metadata components and their complete dependency closure.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metadata.extractByIdentifiers(
+   *   { identifiers: [{ foo: 'bar' }] },
+   * );
+   * ```
+   */
+  extractByIdentifiers(
+    body: MetadataExtractByIdentifiersParams,
+    options?: RequestOptions,
+  ): APIPromise<MetadataExtractByIdentifiersResponse> {
+    return this._client.post('/metadata/extract/', { body, ...options });
+  }
 }
 
 export interface MetadataExtractResponse {
@@ -127,6 +146,35 @@ export namespace MetadataExtractResponse {
   }
 }
 
+export interface MetadataExtractByIdentifiersResponse {
+  /**
+   * Full component configs needed to recreate the requested roots.
+   */
+  component_configs: Array<MetadataExtractByIdentifiersResponse.ComponentConfig>;
+
+  external_managed_dependencies: Array<{ [key: string]: unknown }>;
+
+  /**
+   * Topological install order for the extracted package.
+   */
+  install_order: Array<{ [key: string]: unknown }>;
+}
+
+export namespace MetadataExtractByIdentifiersResponse {
+  /**
+   * A metadata component config. The `type` field selects the concrete component
+   * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
+   */
+  export interface ComponentConfig {
+    /**
+     * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
+     */
+    type: string;
+
+    [k: string]: unknown;
+  }
+}
+
 export interface MetadataExtractParams {
   /**
    * Maximum search results to return when q is provided.
@@ -139,6 +187,10 @@ export interface MetadataExtractParams {
   q?: string;
 }
 
+export interface MetadataExtractByIdentifiersParams {
+  identifiers: Array<{ [key: string]: unknown }>;
+}
+
 Metadata.Types = Types;
 Metadata.Schema = Schema;
 Metadata.Components = Components;
@@ -148,7 +200,9 @@ Metadata.DeploymentRuns = DeploymentRuns;
 export declare namespace Metadata {
   export {
     type MetadataExtractResponse as MetadataExtractResponse,
+    type MetadataExtractByIdentifiersResponse as MetadataExtractByIdentifiersResponse,
     type MetadataExtractParams as MetadataExtractParams,
+    type MetadataExtractByIdentifiersParams as MetadataExtractByIdentifiersParams,
   };
 
   export { Types as Types, type TypeListResponse as TypeListResponse };

package/src/resources/sandboxes.ts

@@ -1,6 +1,7 @@
 // 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';
@@ -32,6 +33,13 @@ export class Sandboxes extends APIResource {
     return this._client.post('/sandboxes/', { body, ...options });
   }
 
+  /**
+   * Retrieve a specific sandbox
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SandboxRetrieveResponse> {
+    return this._client.get(path`/sandboxes/${id}/`, options);
+  }
+
   /**
    * Delete a sandbox
    */
@@ -561,6 +569,262 @@ export namespace SandboxCreateResponse {
   }
 }
 
+/**
+ * Meta information for the response.
+ */
+export interface SandboxRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Display name of the sandbox.
+   */
+  name: string;
+
+  /**
+   * Sandbox type: developer or full data.
+   */
+  type: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
+   */
+  config_override?: SandboxRetrieveResponse.ConfigOverride;
+
+  /**
+   * Optional sandbox description.
+   */
+  description?: string;
+
+  /**
+   * Server-generated sandbox handle.
+   */
+  handle?: string;
+
+  /**
+   * Current lifecycle status.
+   */
+  status?: string;
+}
+
+export namespace SandboxRetrieveResponse {
+  /**
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
+   */
+  export interface ConfigOverride {
+    /**
+     * Custom objects copied into the sandbox.
+     */
+    custom_objects?: ConfigOverride.CustomObjects;
+
+    /**
+     * Required for developer sandboxes and omitted for full-data sandboxes.
+     */
+    developer?: ConfigOverride.Developer;
+
+    /**
+     * General outbound notification controls.
+     */
+    general_notifications?: ConfigOverride.GeneralNotifications;
+
+    /**
+     * Required for connected full-data sandboxes.
+     */
+    integrations?: ConfigOverride.Integrations;
+
+    /**
+     * Required for full-data sandboxes. Developer sandboxes default to CONNECTED.
+     */
+    sandbox_mode?: 'CONNECTED' | 'ISOLATED';
+
+    /**
+     * Workflow webhook controls.
+     */
+    workflow_webhooks?: ConfigOverride.WorkflowWebhooks;
+  }
+
+  export namespace ConfigOverride {
+    /**
+     * Custom objects copied into the sandbox.
+     */
+    export interface CustomObjects {
+      /**
+       * Custom object API names copied into the sandbox.
+       */
+      co_api_names?: Array<string>;
+    }
+
+    /**
+     * Required for developer sandboxes and omitted for full-data sandboxes.
+     */
+    export interface Developer {
+      /**
+       * Seed company size for the developer sandbox.
+       */
+      company_size: 'SMALL' | 'MID' | 'XL';
+    }
+
+    /**
+     * General outbound notification controls.
+     */
+    export interface GeneralNotifications {
+      /**
+       * Email notification configuration.
+       */
+      email: GeneralNotifications.Email;
+
+      /**
+       * Push notification configuration.
+       */
+      push_notifications: GeneralNotifications.PushNotifications;
+
+      /**
+       * SMS notification configuration.
+       */
+      sms: GeneralNotifications.SMS;
+
+      /**
+       * Slack notification configuration.
+       */
+      slack?: GeneralNotifications.Slack;
+
+      /**
+       * Microsoft Teams notification configuration.
+       */
+      teams?: GeneralNotifications.Teams;
+    }
+
+    export namespace GeneralNotifications {
+      /**
+       * Email notification configuration.
+       */
+      export interface Email {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+
+      /**
+       * Push notification configuration.
+       */
+      export interface PushNotifications {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+
+      /**
+       * SMS notification configuration.
+       */
+      export interface SMS {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+
+      /**
+       * Slack notification configuration.
+       */
+      export interface Slack {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Public channels allowed to receive outbound messages.
+         */
+        allowed_public_channels?: Array<string>;
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+
+      /**
+       * Microsoft Teams notification configuration.
+       */
+      export interface Teams {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Public channels allowed to receive outbound messages.
+         */
+        allowed_public_channels?: Array<string>;
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+    }
+
+    /**
+     * Required for connected full-data sandboxes.
+     */
+    export interface Integrations {
+      /**
+       * Confirms acceptance of the risks of connected third-party integrations.
+       */
+      is_risk_acknowledged: boolean;
+    }
+
+    /**
+     * Workflow webhook controls.
+     */
+    export interface WorkflowWebhooks {
+      /**
+       * IP addresses allowed to receive workflow webhooks.
+       */
+      allowed_ips?: Array<string>;
+
+      /**
+       * Webhook URLs allowed in the sandbox.
+       */
+      allowlisted_webhook_urls?: Array<string>;
+
+      /**
+       * Whether workflow webhook traffic is allowed or suppressed.
+       */
+      outbound_behavior?: 'SUPPRESS' | 'ALLOW';
+    }
+  }
+}
+
 /**
  * Company and administrator role used to enter a developer sandbox.
  */
@@ -821,6 +1085,7 @@ export declare namespace Sandboxes {
   export {
     type SandboxListResponse as SandboxListResponse,
     type SandboxCreateResponse as SandboxCreateResponse,
+    type SandboxRetrieveResponse as SandboxRetrieveResponse,
     type SandboxDeveloperSandboxEntryRolesResponse as SandboxDeveloperSandboxEntryRolesResponse,
     type SandboxListResponsesPageCursorURL as SandboxListResponsesPageCursorURL,
     type SandboxListParams as SandboxListParams,

package/src/resources/sites.ts

@@ -8,6 +8,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Custom sites hosted on Rippling
+ */
 export class Sites extends APIResource {
   /**
    * Retrieves sites that the user has view or edit access on. Optional query param