@rippling/rippling-sdk 0.2.0-alpha.87 → 0.2.0-alpha.89

package/src/resources/sandboxes.ts

@@ -0,0 +1,808 @@
+// 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 { PageCursorURL, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Isolated environments used for development and testing
+ */
+export class Sandboxes extends APIResource {
+  /**
+   * A list of sandboxes.
+   *
+   * - Requires: `Developer Base`
+   * - Filterable fields: `handle`, `type`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: SandboxListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SandboxListResponsesPageCursorURL, SandboxListResponse> {
+    return this._client.getAPIList('/sandboxes/', PageCursorURL<SandboxListResponse>, { query, ...options });
+  }
+
+  /**
+   * Create a new sandbox
+   */
+  create(body: SandboxCreateParams, options?: RequestOptions): APIPromise<SandboxCreateResponse> {
+    return this._client.post('/sandboxes/', { body, ...options });
+  }
+
+  /**
+   * Delete a sandbox
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/sandboxes/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type SandboxListResponsesPageCursorURL = PageCursorURL<SandboxListResponse>;
+
+export interface SandboxListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Type-specific sandbox configuration.
+   */
+  config_override: SandboxListResponse.ConfigOverride;
+
+  /**
+   * 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;
+
+  /**
+   * Optional sandbox description.
+   */
+  description?: string;
+
+  /**
+   * Required for developer sandboxes; generated for full-data sandboxes.
+   */
+  handle?: string;
+
+  /**
+   * Current lifecycle status.
+   */
+  status?: string;
+}
+
+export namespace SandboxListResponse {
+  /**
+   * Type-specific sandbox configuration.
+   */
+  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';
+    }
+  }
+}
+
+export interface SandboxCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Type-specific sandbox configuration.
+   */
+  config_override: SandboxCreateResponse.ConfigOverride;
+
+  /**
+   * 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;
+
+  /**
+   * Optional sandbox description.
+   */
+  description?: string;
+
+  /**
+   * Required for developer sandboxes; generated for full-data sandboxes.
+   */
+  handle?: string;
+
+  /**
+   * Current lifecycle status.
+   */
+  status?: string;
+}
+
+export namespace SandboxCreateResponse {
+  /**
+   * Type-specific sandbox configuration.
+   */
+  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';
+    }
+  }
+}
+
+export interface SandboxListParams {
+  cursor?: string;
+
+  filter?: string;
+
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
+  order_by?: string;
+}
+
+export interface SandboxCreateParams {
+  /**
+   * Type-specific sandbox configuration.
+   */
+  config_override: SandboxCreateParams.ConfigOverride;
+
+  /**
+   * Display name of the sandbox.
+   */
+  name: string;
+
+  /**
+   * Sandbox type: developer or full data.
+   */
+  type: string;
+
+  /**
+   * Optional sandbox description.
+   */
+  description?: string;
+
+  /**
+   * Required for developer sandboxes; generated for full-data sandboxes.
+   */
+  handle?: string;
+}
+
+export namespace SandboxCreateParams {
+  /**
+   * Type-specific sandbox configuration.
+   */
+  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';
+    }
+  }
+}
+
+export declare namespace Sandboxes {
+  export {
+    type SandboxListResponse as SandboxListResponse,
+    type SandboxCreateResponse as SandboxCreateResponse,
+    type SandboxListResponsesPageCursorURL as SandboxListResponsesPageCursorURL,
+    type SandboxListParams as SandboxListParams,
+    type SandboxCreateParams as SandboxCreateParams,
+  };
+}