@rippling/rippling-sdk 0.2.0-alpha.106 → 0.2.0-alpha.108

package/resources/workflows/executions.js

@@ -0,0 +1,74 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Executions = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+class Executions extends resource_1.APIResource {
+    /**
+     * Launches a new execution of the workflow's current published version. The
+     * workflow must use a manual trigger and be published and enabled, and the
+     * caller's role must have permission to run it. The request body must be empty:
+     * manual workflow executions accept no input parameters. Executions are not
+     * idempotent: every successful call starts a real execution with real side effects
+     * (messages, callbacks), and a duplicate request starts a second execution. Do not
+     * retry automatically; check an execution's status with GET
+     * /workflows/{id}/executions/{execution_id} instead.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /workflows/{id}/executions/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 201 Created
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "workflow_id": "string",
+     *   "version_id": "string",
+     *   "status": "pending",
+     *   "created_at": "2025-01-01T00:00:00Z"
+     * }
+     * ```
+     */
+    create(id, options) {
+        return this._client.post((0, path_1.path) `/workflows/${id}/executions/`, options);
+    }
+    /**
+     * Returns a workflow execution's current status. Poll until the status reaches a
+     * terminal value (`completed`, `failed`, or `cancelled`); all other values are
+     * transitional.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /workflows/{id}/executions/{execution_id}/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "workflow_id": "string",
+     *   "version_id": "string",
+     *   "status": "pending",
+     *   "created_at": "2025-01-01T00:00:00Z"
+     * }
+     * ```
+     */
+    retrieve(id, executionID, options) {
+        return this._client.get((0, path_1.path) `/workflows/${id}/executions/${executionID}/`, options);
+    }
+}
+exports.Executions = Executions;
+//# sourceMappingURL=executions.js.map

package/resources/workflows/executions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"executions.js","sourceRoot":"","sources":["../../src/resources/workflows/executions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,EAAU,EAAE,WAAmB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,eAAe,WAAW,GAAG,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;CACF;AA/DD,gCA+DC"}

package/resources/workflows/executions.mjs

@@ -0,0 +1,70 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class Executions extends APIResource {
+    /**
+     * Launches a new execution of the workflow's current published version. The
+     * workflow must use a manual trigger and be published and enabled, and the
+     * caller's role must have permission to run it. The request body must be empty:
+     * manual workflow executions accept no input parameters. Executions are not
+     * idempotent: every successful call starts a real execution with real side effects
+     * (messages, callbacks), and a duplicate request starts a second execution. Do not
+     * retry automatically; check an execution's status with GET
+     * /workflows/{id}/executions/{execution_id} instead.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /workflows/{id}/executions/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 201 Created
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "workflow_id": "string",
+     *   "version_id": "string",
+     *   "status": "pending",
+     *   "created_at": "2025-01-01T00:00:00Z"
+     * }
+     * ```
+     */
+    create(id, options) {
+        return this._client.post(path `/workflows/${id}/executions/`, options);
+    }
+    /**
+     * Returns a workflow execution's current status. Poll until the status reaches a
+     * terminal value (`completed`, `failed`, or `cancelled`); all other values are
+     * transitional.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /workflows/{id}/executions/{execution_id}/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "workflow_id": "string",
+     *   "version_id": "string",
+     *   "status": "pending",
+     *   "created_at": "2025-01-01T00:00:00Z"
+     * }
+     * ```
+     */
+    retrieve(id, executionID, options) {
+        return this._client.get(path `/workflows/${id}/executions/${executionID}/`, options);
+    }
+}
+//# sourceMappingURL=executions.mjs.map

package/resources/workflows/executions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"executions.mjs","sourceRoot":"","sources":["../../src/resources/workflows/executions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,cAAc,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,EAAU,EAAE,WAAmB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,eAAe,WAAW,GAAG,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;CACF"}

package/resources/workflows/index.d.mts

@@ -0,0 +1,3 @@
+export { Executions, type ExecutionCreateResponse, type ExecutionRetrieveResponse } from "./executions.mjs";
+export { Workflows, type WorkflowListResponse, type WorkflowCreateResponse, type WorkflowRetrieveResponse, type WorkflowUpdateResponse, type WorkflowListParams, type WorkflowCreateParams, type WorkflowRetrieveParams, type WorkflowUpdateParams, type WorkflowListResponsesPageCursorURL, } from "./workflows.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/workflows/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/workflows/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,KAAK,uBAAuB,EAAE,KAAK,yBAAyB,EAAE,yBAAqB;AACxG,OAAO,EACL,SAAS,EACT,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kCAAkC,GACxC,wBAAoB"}

package/resources/workflows/index.d.ts

@@ -0,0 +1,3 @@
+export { Executions, type ExecutionCreateResponse, type ExecutionRetrieveResponse } from "./executions.js";
+export { Workflows, type WorkflowListResponse, type WorkflowCreateResponse, type WorkflowRetrieveResponse, type WorkflowUpdateResponse, type WorkflowListParams, type WorkflowCreateParams, type WorkflowRetrieveParams, type WorkflowUpdateParams, type WorkflowListResponsesPageCursorURL, } from "./workflows.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/workflows/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/workflows/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,KAAK,uBAAuB,EAAE,KAAK,yBAAyB,EAAE,wBAAqB;AACxG,OAAO,EACL,SAAS,EACT,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kCAAkC,GACxC,uBAAoB"}

package/resources/workflows/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Workflows = exports.Executions = void 0;
+var executions_1 = require("./executions.js");
+Object.defineProperty(exports, "Executions", { enumerable: true, get: function () { return executions_1.Executions; } });
+var workflows_1 = require("./workflows.js");
+Object.defineProperty(exports, "Workflows", { enumerable: true, get: function () { return workflows_1.Workflows; } });
+//# sourceMappingURL=index.js.map

package/resources/workflows/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/workflows/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAAwG;AAA/F,wGAAA,UAAU,OAAA;AACnB,4CAWqB;AAVnB,sGAAA,SAAS,OAAA"}

package/resources/workflows/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Executions } from "./executions.mjs";
+export { Workflows, } from "./workflows.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/workflows/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/workflows/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,UAAU,EAAgE,yBAAqB;AACxG,OAAO,EACL,SAAS,GAUV,wBAAoB"}