@rippling/rippling-sdk 0.2.0-alpha.20

package/src/resources/functions/executions.ts

@@ -0,0 +1,273 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Executions extends APIResource {
+  /**
+   * Create a new function execution
+   */
+  create(
+    functionAPIName: string,
+    body: ExecutionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ExecutionCreateResponse> {
+    return this._client.post(path`/functions/${functionAPIName}/executions/`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific function execution
+   */
+  retrieve(
+    executionID: string,
+    params: ExecutionRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ExecutionRetrieveResponse> {
+    const { function_api_name } = params;
+    return this._client.get(path`/functions/${function_api_name}/executions/${executionID}/`, options);
+  }
+
+  /**
+   * A List of function executions
+   *
+   * - Requires: `Functions API`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    functionAPIName: string,
+    query: ExecutionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ExecutionListResponsesPageCursorURL, ExecutionListResponse> {
+    return this._client.getAPIList(
+      path`/functions/${functionAPIName}/executions/`,
+      PageCursorURL<ExecutionListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * A List of function execution logs
+   *
+   * - Requires: `Functions API`
+   */
+  listLogs(
+    executionID: string,
+    params: ExecutionListLogsParams,
+    options?: RequestOptions,
+  ): APIPromise<ExecutionListLogsResponse> {
+    const { function_api_name } = params;
+    return this._client.get(path`/functions/${function_api_name}/executions/${executionID}/logs/`, options);
+  }
+}
+
+export type ExecutionListResponsesPageCursorURL = PageCursorURL<ExecutionListResponse>;
+
+export interface ExecutionCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The ID of the function this execution belongs to
+   */
+  function_id: string;
+
+  /**
+   * The inputs of the execution
+   */
+  inputs: unknown;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The end time of the execution
+   */
+  finished_at?: string;
+
+  /**
+   * The outputs of the execution
+   */
+  outputs?: unknown;
+
+  /**
+   * The start time of the execution
+   */
+  started_at?: string;
+
+  /**
+   * The status of the execution
+   */
+  status?: string;
+}
+
+export interface ExecutionRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The ID of the function this execution belongs to
+   */
+  function_id: string;
+
+  /**
+   * The inputs of the execution
+   */
+  inputs: unknown;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The end time of the execution
+   */
+  finished_at?: string;
+
+  /**
+   * The outputs of the execution
+   */
+  outputs?: unknown;
+
+  /**
+   * The start time of the execution
+   */
+  started_at?: string;
+
+  /**
+   * The status of the execution
+   */
+  status?: string;
+}
+
+export interface ExecutionListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The ID of the function this execution belongs to
+   */
+  function_id: string;
+
+  /**
+   * The inputs of the execution
+   */
+  inputs: unknown;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The end time of the execution
+   */
+  finished_at?: string;
+
+  /**
+   * The outputs of the execution
+   */
+  outputs?: unknown;
+
+  /**
+   * The start time of the execution
+   */
+  started_at?: string;
+
+  /**
+   * The status of the execution
+   */
+  status?: string;
+}
+
+export interface ExecutionListLogsResponse {
+  results?: Array<ExecutionListLogsResponse.Result>;
+}
+
+export namespace ExecutionListLogsResponse {
+  export interface Result {
+    /**
+     * The log message
+     */
+    message: string;
+
+    /**
+     * The sequence number of the log line
+     */
+    sequence_num: number;
+
+    /**
+     * The log level
+     */
+    level?: string;
+
+    /**
+     * Parameters associated with the log line
+     */
+    params?: unknown;
+
+    /**
+     * The log timestamp
+     */
+    timestamp?: string;
+  }
+}
+
+export interface ExecutionCreateParams {
+  /**
+   * The inputs of the execution
+   */
+  inputs: unknown;
+}
+
+export interface ExecutionRetrieveParams {
+  function_api_name: string;
+}
+
+export interface ExecutionListParams {
+  order_by?: string;
+}
+
+export interface ExecutionListLogsParams {
+  function_api_name: string;
+}
+
+export declare namespace Executions {
+  export {
+    type ExecutionCreateResponse as ExecutionCreateResponse,
+    type ExecutionRetrieveResponse as ExecutionRetrieveResponse,
+    type ExecutionListResponse as ExecutionListResponse,
+    type ExecutionListLogsResponse as ExecutionListLogsResponse,
+    type ExecutionListResponsesPageCursorURL as ExecutionListResponsesPageCursorURL,
+    type ExecutionCreateParams as ExecutionCreateParams,
+    type ExecutionRetrieveParams as ExecutionRetrieveParams,
+    type ExecutionListParams as ExecutionListParams,
+    type ExecutionListLogsParams as ExecutionListLogsParams,
+  };
+}

package/src/resources/functions/functions.ts

@@ -0,0 +1,229 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as DeploymentsAPI from './deployments';
+import {
+  DeploymentCreateParams,
+  DeploymentListLogsParams,
+  DeploymentListLogsResponse,
+  DeploymentListResponse,
+  DeploymentRetrieveParams,
+  Deployments,
+  FunctionDeployment,
+} from './deployments';
+import * as ExecutionsAPI from './executions';
+import {
+  ExecutionCreateParams,
+  ExecutionCreateResponse,
+  ExecutionListLogsParams,
+  ExecutionListLogsResponse,
+  ExecutionListParams,
+  ExecutionListResponse,
+  ExecutionListResponsesPageCursorURL,
+  ExecutionRetrieveParams,
+  ExecutionRetrieveResponse,
+  Executions,
+} from './executions';
+import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Functions extends APIResource {
+  deployments: DeploymentsAPI.Deployments = new DeploymentsAPI.Deployments(this._client);
+  executions: ExecutionsAPI.Executions = new ExecutionsAPI.Executions(this._client);
+
+  /**
+   * Create a new function
+   */
+  create(body: FunctionCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise<Function> {
+    return this._client.post('/functions/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific function
+   */
+  retrieve(functionAPIName: string, options?: RequestOptions): APIPromise<Function> {
+    return this._client.get(path`/functions/${functionAPIName}/`, options);
+  }
+
+  /**
+   * Update a function
+   */
+  update(
+    functionAPIName: string,
+    body: FunctionUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Function> {
+    return this._client.patch(path`/functions/${functionAPIName}/`, { body, ...options });
+  }
+
+  /**
+   * A List of functions
+   *
+   * - Requires: `Functions API`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: FunctionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FunctionsPageCursorURL, Function> {
+    return this._client.getAPIList('/functions/', PageCursorURL<Function>, { query, ...options });
+  }
+
+  /**
+   * Create a new function dev bundle
+   */
+  createDevBundle(
+    functionAPIName: string,
+    options?: RequestOptions,
+  ): APIPromise<FunctionCreateDevBundleResponse> {
+    return this._client.post(path`/functions/${functionAPIName}/dev_bundles/`, options);
+  }
+}
+
+export type FunctionsPageCursorURL = PageCursorURL<Function>;
+
+export interface Function {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The API name of the function
+   */
+  api_name?: string;
+
+  /**
+   * The current draft of code for the function
+   */
+  code_draft?: string;
+
+  /**
+   * The dependencies of the function
+   */
+  dependencies?: unknown;
+
+  /**
+   * The function description
+   */
+  description?: string;
+
+  /**
+   * The function name
+   */
+  name?: string;
+}
+
+export interface FunctionCreateDevBundleResponse {
+  /**
+   * The bundle contents as a base64 encoded zip
+   */
+  contents?: string;
+}
+
+export interface FunctionCreateParams {
+  /**
+   * The API name of the function
+   */
+  api_name?: string;
+
+  /**
+   * The current draft of code for the function
+   */
+  code_draft?: string;
+
+  /**
+   * The dependencies of the function
+   */
+  dependencies?: unknown;
+
+  /**
+   * The function description
+   */
+  description?: string;
+
+  /**
+   * The function name
+   */
+  name?: string;
+}
+
+export interface FunctionUpdateParams {
+  /**
+   * The API name of the function
+   */
+  api_name?: string;
+
+  /**
+   * The current draft of code for the function
+   */
+  code_draft?: string;
+
+  /**
+   * The dependencies of the function
+   */
+  dependencies?: unknown;
+
+  /**
+   * The function description
+   */
+  description?: string;
+
+  /**
+   * The function name
+   */
+  name?: string;
+}
+
+export interface FunctionListParams {
+  order_by?: string;
+}
+
+Functions.Deployments = Deployments;
+Functions.Executions = Executions;
+
+export declare namespace Functions {
+  export {
+    type Function as Function,
+    type FunctionCreateDevBundleResponse as FunctionCreateDevBundleResponse,
+    type FunctionsPageCursorURL as FunctionsPageCursorURL,
+    type FunctionCreateParams as FunctionCreateParams,
+    type FunctionUpdateParams as FunctionUpdateParams,
+    type FunctionListParams as FunctionListParams,
+  };
+
+  export {
+    Deployments as Deployments,
+    type FunctionDeployment as FunctionDeployment,
+    type DeploymentListResponse as DeploymentListResponse,
+    type DeploymentListLogsResponse as DeploymentListLogsResponse,
+    type DeploymentCreateParams as DeploymentCreateParams,
+    type DeploymentRetrieveParams as DeploymentRetrieveParams,
+    type DeploymentListLogsParams as DeploymentListLogsParams,
+  };
+
+  export {
+    Executions as Executions,
+    type ExecutionCreateResponse as ExecutionCreateResponse,
+    type ExecutionRetrieveResponse as ExecutionRetrieveResponse,
+    type ExecutionListResponse as ExecutionListResponse,
+    type ExecutionListLogsResponse as ExecutionListLogsResponse,
+    type ExecutionListResponsesPageCursorURL as ExecutionListResponsesPageCursorURL,
+    type ExecutionCreateParams as ExecutionCreateParams,
+    type ExecutionRetrieveParams as ExecutionRetrieveParams,
+    type ExecutionListParams as ExecutionListParams,
+    type ExecutionListLogsParams as ExecutionListLogsParams,
+  };
+}

package/src/resources/functions/index.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Deployments,
+  type FunctionDeployment,
+  type DeploymentListResponse,
+  type DeploymentListLogsResponse,
+  type DeploymentCreateParams,
+  type DeploymentRetrieveParams,
+  type DeploymentListLogsParams,
+} from './deployments';
+export {
+  Executions,
+  type ExecutionCreateResponse,
+  type ExecutionRetrieveResponse,
+  type ExecutionListResponse,
+  type ExecutionListLogsResponse,
+  type ExecutionCreateParams,
+  type ExecutionRetrieveParams,
+  type ExecutionListParams,
+  type ExecutionListLogsParams,
+  type ExecutionListResponsesPageCursorURL,
+} from './executions';
+export {
+  Functions,
+  type Function,
+  type FunctionCreateDevBundleResponse,
+  type FunctionCreateParams,
+  type FunctionUpdateParams,
+  type FunctionListParams,
+  type FunctionsPageCursorURL,
+} from './functions';

package/src/resources/functions.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './functions/index';