@rippling/rippling-sdk 0.2.0-alpha.93 → 0.2.0-alpha.95

package/src/lib/manifest/index.ts

@@ -4,12 +4,22 @@ export { Agent, type AgentIdentityMode, type AgentProps, type AgentSourceFile }
 
 export {
   ACPAgent,
+  type ACPAgentEventKey,
   type ACPAgentEventTrigger,
   type ACPAgentIdentityMode,
   type ACPAgentProps,
   type ACPAgentSourceFile,
 } from './acp-agent';
 
+export {
+  approvalBusinessEventKey,
+  BusinessEvent,
+  type ApprovalBusinessEventKey,
+  type ApprovalBusinessEventOutcome,
+  type BusinessEventKey,
+  type StaticBusinessEventKey,
+} from './business-event';
+
 export {
   generateId,
   type EdgeType,
@@ -249,6 +259,7 @@ export {
   Workflow,
   type WorkflowAutomationEventType,
   type WorkflowAnnualSchedule,
+  type WorkflowBusinessEventKey,
   type WorkflowBusinessTrigger,
   type WorkflowCronSchedule,
   type WorkflowCustomSchedule,

package/src/lib/manifest/workflow.ts

@@ -1,4 +1,5 @@
 import { generateId } from './_helpers';
+import type { BusinessEventKey } from './business-event';
 import type { ManifestFunction } from './manifest-function';
 import type { ManifestComponentDeletion, ManifestScope } from './manifest-builder';
 
@@ -103,12 +104,15 @@ export interface WorkflowTriggerBase {
 
 export interface WorkflowBusinessTrigger extends WorkflowTriggerBase {
   automation_event_type: 'AUTOMATION_EVENT_TYPE_BUSINESS';
-  event_name: string;
+  /** Business event to subscribe to. Availability is validated during installation. */
+  event_name: BusinessEventKey;
   business_event_trigger?: {
     navigation_path?: string;
   };
 }
 
+export type WorkflowBusinessEventKey = BusinessEventKey;
+
 export interface WorkflowRecordChangeTrigger extends WorkflowTriggerBase {
   automation_event_type: 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE';
   record_change_operation_type: WorkflowRecordChangeOperationType;

package/src/resources/index.ts

@@ -399,6 +399,12 @@ export {
   type PackageUninstallRetrieveResponse,
   type PackageUninstallCreateParams,
 } from './package-uninstalls';
+export {
+  PackageUpgrades,
+  type PackageUpgradeCreateResponse,
+  type PackageUpgradeRetrieveResponse,
+  type PackageUpgradeCreateParams,
+} from './package-upgrades';
 export {
   PackageVersionComponentUpdates,
   type PackageVersionComponentUpdateCreateResponse,
@@ -409,7 +415,7 @@ export {
   PackageVersions,
   type PackageVersionUpdateResponse,
   type PackageVersionUpdateParams,
-} from './package-versions/package-versions';
+} from './package-versions';
 export {
   Packages,
   type PackageListResponse,

package/src/resources/metadata/components.ts

@@ -8,65 +8,6 @@ import { RequestOptions } from '../../internal/request-options';
  * Custom objects defined by the company
  */
 export class Components extends APIResource {
-  /**
-   * Extract the company's selectable metadata components, optionally filtered by a
-   * search query.
-   *
-   * Requires the Metadata entitlement.
-   *
-   * @example
-   * ```ts
-   * const response = await client.metadata.components.extract();
-   * ```
-   */
-  extract(
-    query: ComponentExtractParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ComponentExtractResponse> {
-    return this._client.get('/metadata/v2/extract/', { query, ...options });
-  }
-
-  /**
-   * Validate component schemas and dependencies without installing them. Use the
-   * normalized results before deploy.
-   *
-   * Requires the Metadata entitlement.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.metadata.components.validateV2({
-   *     components: [
-   *       {
-   *         type: 'CUSTOM_OBJECT',
-   *         api_name: 'purchase_order__c',
-   *         name: 'Purchase Order',
-   *         description: 'Tracks purchase requests',
-   *         category_api_name: 'procurement__c',
-   *       },
-   *       {
-   *         type: 'CUSTOM_OBJECT_FIELD',
-   *         custom_object_api_name: 'purchase_order__c',
-   *         field_api_name: 'amount__c',
-   *         field_display_name: 'Amount',
-   *         data_type: {
-   *           field_type: 'CURRENCY',
-   *           currency: 'USD',
-   *           num_of_decimal_places: 2,
-   *         },
-   *         is_standard: false,
-   *       },
-   *     ],
-   *   });
-   * ```
-   */
-  validateV2(
-    body: ComponentValidateV2Params,
-    options?: RequestOptions,
-  ): APIPromise<ComponentValidateV2Response> {
-    return this._client.post('/metadata/v2/validate/', { body, ...options });
-  }
-
   /**
    * Validate a complete metadata component package without installing it.
    *
@@ -141,190 +82,6 @@ export class Components extends APIResource {
   }
 }
 
-export interface ComponentExtractResponse {
-  /**
-   * Full component configs needed to recreate the selected roots.
-   */
-  component_configs: Array<ComponentExtractResponse.ComponentConfig>;
-
-  /**
-   * Serialized dependency graph for the extracted package.
-   */
-  dependency_graph: { [key: string]: unknown };
-
-  /**
-   * Topological install order for the extracted package.
-   */
-  install_order: Array<{ [key: string]: unknown }>;
-
-  /**
-   * Components selected as extraction roots.
-   */
-  root_components: Array<ComponentExtractResponse.RootComponent>;
-
-  /**
-   * For search-backed extraction, whether contextual expansion completed.
-   */
-  context_complete?: boolean;
-
-  /**
-   * Warnings from search-backed contextual expansion.
-   */
-  context_warnings?: Array<string>;
-
-  external_managed_dependencies?: Array<{ [key: string]: unknown }>;
-
-  [k: string]: unknown;
-}
-
-export namespace ComponentExtractResponse {
-  /**
-   * 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;
-  }
-
-  /**
-   * Selectable package root returned by metadata extraction.
-   */
-  export interface RootComponent {
-    /**
-     * Identifier for the selected component.
-     */
-    identifier?: { [key: string]: unknown };
-
-    /**
-     * Display name for the selectable component.
-     */
-    name?: string;
-
-    [k: string]: unknown;
-  }
-}
-
-export interface ComponentValidateV2Response {
-  /**
-   * Package-level validation issues.
-   */
-  errors: Array<ComponentValidateV2Response.Error>;
-
-  /**
-   * Per-component validation results.
-   */
-  results: Array<ComponentValidateV2Response.Result>;
-
-  /**
-   * True only when every component and dependency check passed.
-   */
-  valid: boolean;
-}
-
-export namespace ComponentValidateV2Response {
-  /**
-   * A validation, dependency, permission, or deployment issue.
-   */
-  export interface Error {
-    /**
-     * Stable machine-readable issue code.
-     */
-    code: string;
-
-    /**
-     * Human-readable remediation message.
-     */
-    message: string;
-
-    /**
-     * Lower-level cause associated with the issue, when available.
-     */
-    cause?: string | null;
-
-    /**
-     * Component type associated with the issue, when available.
-     */
-    component_type?: string | null;
-
-    [k: string]: unknown;
-  }
-
-  export interface Result {
-    /**
-     * Metadata component type.
-     */
-    type: string;
-
-    /**
-     * Whether this component passed validation.
-     */
-    valid: boolean;
-
-    errors?: Array<Result.Error>;
-
-    /**
-     * Existing component config matched by the identifier, when available.
-     */
-    existing?: { [key: string]: unknown };
-
-    /**
-     * Resolved component identifier.
-     */
-    identifier?: { [key: string]: unknown };
-
-    /**
-     * Merged target state for updates, when available.
-     */
-    merged?: { [key: string]: unknown };
-
-    /**
-     * Schema-normalized component config.
-     */
-    normalized?: { [key: string]: unknown };
-
-    /**
-     * Upsert classification computed during validation.
-     */
-    outcome?: 'CREATE' | 'NO_OP' | 'UPDATE' | 'UNSUPPORTED_UPDATE' | null;
-
-    [k: string]: unknown;
-  }
-
-  export namespace Result {
-    /**
-     * A validation, dependency, permission, or deployment issue.
-     */
-    export interface Error {
-      /**
-       * Stable machine-readable issue code.
-       */
-      code: string;
-
-      /**
-       * Human-readable remediation message.
-       */
-      message: string;
-
-      /**
-       * Lower-level cause associated with the issue, when available.
-       */
-      cause?: string | null;
-
-      /**
-       * Component type associated with the issue, when available.
-       */
-      component_type?: string | null;
-
-      [k: string]: unknown;
-    }
-  }
-}
-
 export interface ComponentValidateResponse {
   /**
    * Package-level validation issues.
@@ -538,40 +295,6 @@ export namespace ComponentDeployResponse {
   }
 }
 
-export interface ComponentExtractParams {
-  /**
-   * Maximum search results to return when q is provided.
-   */
-  limit?: number;
-
-  /**
-   * Optional text search over selectable components.
-   */
-  q?: string;
-}
-
-export interface ComponentValidateV2Params {
-  /**
-   * Complete package of metadata components, including dependencies.
-   */
-  components: Array<ComponentValidateV2Params.Component>;
-}
-
-export namespace ComponentValidateV2Params {
-  /**
-   * A metadata component config. The `type` field selects the concrete component
-   * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
-   */
-  export interface Component {
-    /**
-     * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
-     */
-    type: string;
-
-    [k: string]: unknown;
-  }
-}
-
 export interface ComponentValidateParams {
   /**
    * Complete package of metadata components, including dependencies.
@@ -618,12 +341,8 @@ export namespace ComponentDeployParams {
 
 export declare namespace Components {
   export {
-    type ComponentExtractResponse as ComponentExtractResponse,
-    type ComponentValidateV2Response as ComponentValidateV2Response,
     type ComponentValidateResponse as ComponentValidateResponse,
     type ComponentDeployResponse as ComponentDeployResponse,
-    type ComponentExtractParams as ComponentExtractParams,
-    type ComponentValidateV2Params as ComponentValidateV2Params,
     type ComponentValidateParams as ComponentValidateParams,
     type ComponentDeployParams as ComponentDeployParams,
   };

package/src/resources/metadata/deployment-runs.ts

@@ -10,71 +10,6 @@ import { path } from '../../internal/utils/path';
  * Custom objects defined by the company
  */
 export class DeploymentRuns extends APIResource {
-  /**
-   * Queue deployment for a metadata component package and return a run id for
-   * polling.
-   *
-   * Requires the Metadata entitlement.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.metadata.deploymentRuns.createV2({
-   *     components: [
-   *       {
-   *         type: 'CUSTOM_OBJECT',
-   *         api_name: 'purchase_order__c',
-   *         name: 'Purchase Order',
-   *         description: 'Tracks purchase requests',
-   *         category_api_name: 'procurement__c',
-   *       },
-   *       {
-   *         type: 'CUSTOM_OBJECT_FIELD',
-   *         custom_object_api_name: 'purchase_order__c',
-   *         field_api_name: 'amount__c',
-   *         field_display_name: 'Amount',
-   *         data_type: {
-   *           field_type: 'CURRENCY',
-   *           currency: 'USD',
-   *           num_of_decimal_places: 2,
-   *         },
-   *         is_standard: false,
-   *       },
-   *     ],
-   *   });
-   * ```
-   */
-  createV2(
-    params: DeploymentRunCreateV2Params,
-    options?: RequestOptions,
-  ): APIPromise<DeploymentRunCreateV2Response> {
-    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
-    return this._client.post('/metadata/v2/deployment-runs/', {
-      body,
-      ...options,
-      headers: buildHeaders([
-        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
-        options?.headers,
-      ]),
-    });
-  }
-
-  /**
-   * Poll a metadata deployment run until the terminal field is true.
-   *
-   * Requires the Metadata entitlement.
-   *
-   * @example
-   * ```ts
-   * const response = await client.metadata.deploymentRuns.getV2(
-   *   'run_id',
-   * );
-   * ```
-   */
-  getV2(runID: string, options?: RequestOptions): APIPromise<DeploymentRunGetV2Response> {
-    return this._client.get(path`/metadata/v2/deployment-runs/${runID}/`, options);
-  }
-
   /**
    * Queue deployment for a metadata component package and return a run id for
    * polling.
@@ -140,80 +75,6 @@ export class DeploymentRuns extends APIResource {
   }
 }
 
-export interface DeploymentRunCreateV2Response {
-  /**
-   * Metadata run id.
-   */
-  id: string;
-
-  progress: { [key: string]: unknown };
-
-  /**
-   * Suggested client polling delay in milliseconds.
-   */
-  retry_after_ms: number;
-
-  status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
-
-  /**
-   * Whether the run has reached a terminal status.
-   */
-  terminal: boolean;
-
-  type: 'validation' | 'deployment';
-
-  created_at?: string | null;
-
-  error?: { [key: string]: unknown } | null;
-
-  expires_at?: string | null;
-
-  finished_at?: string | null;
-
-  result?: { [key: string]: unknown } | null;
-
-  started_at?: string | null;
-
-  updated_at?: string | null;
-}
-
-export interface DeploymentRunGetV2Response {
-  /**
-   * Metadata run id.
-   */
-  id: string;
-
-  progress: { [key: string]: unknown };
-
-  /**
-   * Suggested client polling delay in milliseconds.
-   */
-  retry_after_ms: number;
-
-  status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
-
-  /**
-   * Whether the run has reached a terminal status.
-   */
-  terminal: boolean;
-
-  type: 'validation' | 'deployment';
-
-  created_at?: string | null;
-
-  error?: { [key: string]: unknown } | null;
-
-  expires_at?: string | null;
-
-  finished_at?: string | null;
-
-  result?: { [key: string]: unknown } | null;
-
-  started_at?: string | null;
-
-  updated_at?: string | null;
-}
-
 export interface DeploymentRunCreateResponse {
   /**
    * Metadata run id.
@@ -288,34 +149,6 @@ export interface DeploymentRunGetResponse {
   updated_at?: string | null;
 }
 
-export interface DeploymentRunCreateV2Params {
-  /**
-   * Body param: Complete package of metadata components, including dependencies.
-   */
-  components: Array<DeploymentRunCreateV2Params.Component>;
-
-  /**
-   * Header param: Optional idempotency key used to deduplicate retried create
-   * requests.
-   */
-  'Idempotency-Key'?: string;
-}
-
-export namespace DeploymentRunCreateV2Params {
-  /**
-   * A metadata component config. The `type` field selects the concrete component
-   * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
-   */
-  export interface Component {
-    /**
-     * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
-     */
-    type: string;
-
-    [k: string]: unknown;
-  }
-}
-
 export interface DeploymentRunCreateParams {
   /**
    * Body param: Complete package of metadata components, including dependencies.
@@ -346,11 +179,8 @@ export namespace DeploymentRunCreateParams {
 
 export declare namespace DeploymentRuns {
   export {
-    type DeploymentRunCreateV2Response as DeploymentRunCreateV2Response,
-    type DeploymentRunGetV2Response as DeploymentRunGetV2Response,
     type DeploymentRunCreateResponse as DeploymentRunCreateResponse,
     type DeploymentRunGetResponse as DeploymentRunGetResponse,
-    type DeploymentRunCreateV2Params as DeploymentRunCreateV2Params,
     type DeploymentRunCreateParams as DeploymentRunCreateParams,
   };
 }

package/src/resources/metadata/index.ts

@@ -1,29 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  ComponentSchemas,
-  type ComponentSchemaGetResponse,
-  type ComponentSchemaGetParams,
-} from './component-schemas';
-export { ComponentTypes, type ComponentTypeListResponse } from './component-types';
 export {
   Components,
-  type ComponentExtractResponse,
-  type ComponentValidateV2Response,
   type ComponentValidateResponse,
   type ComponentDeployResponse,
-  type ComponentExtractParams,
-  type ComponentValidateV2Params,
   type ComponentValidateParams,
   type ComponentDeployParams,
 } from './components';
 export {
   DeploymentRuns,
-  type DeploymentRunCreateV2Response,
-  type DeploymentRunGetV2Response,
   type DeploymentRunCreateResponse,
   type DeploymentRunGetResponse,
-  type DeploymentRunCreateV2Params,
   type DeploymentRunCreateParams,
 } from './deployment-runs';
 export { Metadata, type MetadataExtractResponse, type MetadataExtractParams } from './metadata';
@@ -31,10 +18,7 @@ export { Schema, type SchemaGetResponse, type SchemaGetParams } from './schema';
 export { Types, type TypeListResponse } from './types';
 export {
   ValidationRuns,
-  type ValidationRunCreateV2Response,
-  type ValidationRunGetV2Response,
   type ValidationRunCreateResponse,
   type ValidationRunGetResponse,
-  type ValidationRunCreateV2Params,
   type ValidationRunCreateParams,
 } from './validation-runs';