@rippling/rippling-sdk 0.2.0-alpha.100 → 0.2.0-alpha.102

package/resources/functions/deployments.js

@@ -12,18 +12,121 @@ class Deployments extends resource_1.APIResource {
      * A list of function deployments.
      *
      * - Requires: `API Tier 1`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/deployments/ 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
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "external_id": "string",
+     *       "function_id": "string",
+     *       "function_api_name": "string",
+     *       "function_version_id": "string",
+     *       "function_version_human_friendly_id": 0,
+     *       "code": "string",
+     *       "dependencies": {},
+     *       "allowed_domains": [
+     *         "string"
+     *       ],
+     *       "runtime": "string",
+     *       "options": {},
+     *       "io_contract": {},
+     *       "status": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string"
+     *     }
+     *   ]
+     * }
+     * ```
      */
     list(functionAPIName, options) {
         return this._client.get((0, path_1.path) `/functions/${functionAPIName}/deployments/`, options);
     }
     /**
      * Create a new function deployment.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /functions/{function_api_name}/deployments/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {}
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "external_id": "string",
+     *   "function_id": "string",
+     *   "function_api_name": "string",
+     *   "function_version_id": "string",
+     *   "function_version_human_friendly_id": 0,
+     *   "code": "string",
+     *   "dependencies": {},
+     *   "allowed_domains": [
+     *     "string"
+     *   ],
+     *   "runtime": "string",
+     *   "options": {},
+     *   "io_contract": {},
+     *   "status": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string"
+     * }
+     * ```
      */
     create(functionAPIName, body = {}, options) {
         return this._client.post((0, path_1.path) `/functions/${functionAPIName}/deployments/`, { body, ...options });
     }
     /**
      * Retrieve a specific function deployment.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/deployments/{deployment_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",
+     *   "external_id": "string",
+     *   "function_id": "string",
+     *   "function_api_name": "string",
+     *   "function_version_id": "string",
+     *   "function_version_human_friendly_id": 0,
+     *   "code": "string",
+     *   "dependencies": {},
+     *   "allowed_domains": [
+     *     "string"
+     *   ],
+     *   "runtime": "string",
+     *   "options": {},
+     *   "io_contract": {},
+     *   "status": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string"
+     * }
+     * ```
      */
     retrieve(deploymentID, params, options) {
         const { function_api_name } = params;
@@ -33,6 +136,30 @@ class Deployments extends resource_1.APIResource {
      * A list of function deployment logs.
      *
      * - Requires: `API Tier 1`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/deployments/{deployment_id}/logs/ 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
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "message": "string",
+     *       "sequence_num": 0,
+     *       "timestamp": "string",
+     *       "level": "string",
+     *       "params": {}
+     *     }
+     *   ]
+     * }
+     * ```
      */
     listLogs(deploymentID, params, options) {
         const { function_api_name } = params;

package/resources/functions/deployments.js.map

@@ -1 +1 @@
-{"version":3,"file":"deployments.js","sourceRoot":"","sources":["../../src/resources/functions/deployments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;OAIG;IACH,IAAI,CAAC,eAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,eAAe,eAAe,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,eAAuB,EACvB,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,cAAc,eAAe,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,iBAAiB,gBAAgB,YAAY,GAAG,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,iBAAiB,gBAAgB,YAAY,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5G,CAAC;CACF;AA9CD,kCA8CC"}
+{"version":3,"file":"deployments.js","sourceRoot":"","sources":["../../src/resources/functions/deployments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,IAAI,CAAC,eAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,eAAe,eAAe,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CACJ,eAAuB,EACvB,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,cAAc,eAAe,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,iBAAiB,gBAAgB,YAAY,GAAG,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,iBAAiB,gBAAgB,YAAY,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5G,CAAC;CACF;AA7KD,kCA6KC"}

package/resources/functions/deployments.mjs

@@ -9,18 +9,121 @@ export class Deployments extends APIResource {
      * A list of function deployments.
      *
      * - Requires: `API Tier 1`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/deployments/ 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
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "external_id": "string",
+     *       "function_id": "string",
+     *       "function_api_name": "string",
+     *       "function_version_id": "string",
+     *       "function_version_human_friendly_id": 0,
+     *       "code": "string",
+     *       "dependencies": {},
+     *       "allowed_domains": [
+     *         "string"
+     *       ],
+     *       "runtime": "string",
+     *       "options": {},
+     *       "io_contract": {},
+     *       "status": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string"
+     *     }
+     *   ]
+     * }
+     * ```
      */
     list(functionAPIName, options) {
         return this._client.get(path `/functions/${functionAPIName}/deployments/`, options);
     }
     /**
      * Create a new function deployment.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /functions/{function_api_name}/deployments/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {}
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "external_id": "string",
+     *   "function_id": "string",
+     *   "function_api_name": "string",
+     *   "function_version_id": "string",
+     *   "function_version_human_friendly_id": 0,
+     *   "code": "string",
+     *   "dependencies": {},
+     *   "allowed_domains": [
+     *     "string"
+     *   ],
+     *   "runtime": "string",
+     *   "options": {},
+     *   "io_contract": {},
+     *   "status": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string"
+     * }
+     * ```
      */
     create(functionAPIName, body = {}, options) {
         return this._client.post(path `/functions/${functionAPIName}/deployments/`, { body, ...options });
     }
     /**
      * Retrieve a specific function deployment.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/deployments/{deployment_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",
+     *   "external_id": "string",
+     *   "function_id": "string",
+     *   "function_api_name": "string",
+     *   "function_version_id": "string",
+     *   "function_version_human_friendly_id": 0,
+     *   "code": "string",
+     *   "dependencies": {},
+     *   "allowed_domains": [
+     *     "string"
+     *   ],
+     *   "runtime": "string",
+     *   "options": {},
+     *   "io_contract": {},
+     *   "status": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string"
+     * }
+     * ```
      */
     retrieve(deploymentID, params, options) {
         const { function_api_name } = params;
@@ -30,6 +133,30 @@ export class Deployments extends APIResource {
      * A list of function deployment logs.
      *
      * - Requires: `API Tier 1`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/deployments/{deployment_id}/logs/ 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
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "message": "string",
+     *       "sequence_num": 0,
+     *       "timestamp": "string",
+     *       "level": "string",
+     *       "params": {}
+     *     }
+     *   ]
+     * }
+     * ```
      */
     listLogs(deploymentID, params, options) {
         const { function_api_name } = params;

package/resources/functions/deployments.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"deployments.mjs","sourceRoot":"","sources":["../../src/resources/functions/deployments.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;OAIG;IACH,IAAI,CAAC,eAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,eAAe,eAAe,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,eAAuB,EACvB,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,cAAc,eAAe,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,iBAAiB,gBAAgB,YAAY,GAAG,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,iBAAiB,gBAAgB,YAAY,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5G,CAAC;CACF"}
+{"version":3,"file":"deployments.mjs","sourceRoot":"","sources":["../../src/resources/functions/deployments.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,IAAI,CAAC,eAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,eAAe,eAAe,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CACJ,eAAuB,EACvB,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,cAAc,eAAe,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,iBAAiB,gBAAgB,YAAY,GAAG,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CACN,YAAoB,EACpB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,iBAAiB,gBAAgB,YAAY,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5G,CAAC;CACF"}

package/resources/functions/executions.d.mts

@@ -11,20 +11,126 @@ export declare class Executions extends APIResource {
      *
      * - Requires: `API Tier 1`
      * - Sortable fields: `id`, `created_at`, `updated_at`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/executions/?order_by=order_by&limit=50&cursor=cursor 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
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "function_id": "string",
+     *       "inputs": {},
+     *       "outputs": {},
+     *       "status": "string",
+     *       "started_at": "string",
+     *       "finished_at": "string"
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
      */
     list(functionAPIName: string, query?: ExecutionListParams | null | undefined, options?: RequestOptions): PagePromise<FunctionExecutionsPageCursorURL, FunctionExecution>;
     /**
      * Create a new function execution.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /functions/{function_api_name}/executions/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "inputs": {}
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "function_id": "string",
+     *   "inputs": {},
+     *   "outputs": {},
+     *   "status": "string",
+     *   "started_at": "string",
+     *   "finished_at": "string"
+     * }
+     * ```
      */
     create(functionAPIName: string, body: ExecutionCreateParams, options?: RequestOptions): APIPromise<FunctionExecution>;
     /**
      * Retrieve a specific function execution.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/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",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "function_id": "string",
+     *   "inputs": {},
+     *   "outputs": {},
+     *   "status": "string",
+     *   "started_at": "string",
+     *   "finished_at": "string"
+     * }
+     * ```
      */
     retrieve(executionID: string, params: ExecutionRetrieveParams, options?: RequestOptions): APIPromise<FunctionExecution>;
     /**
      * A list of function execution logs.
      *
      * - Requires: `API Tier 1`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/executions/{execution_id}/logs/ 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
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "message": "string",
+     *       "sequence_num": 0,
+     *       "timestamp": "string",
+     *       "level": "string",
+     *       "params": {}
+     *     }
+     *   ]
+     * }
+     * ```
      */
     listLogs(executionID: string, params: ExecutionListLogsParams, options?: RequestOptions): APIPromise<ExecutionListLogsResponse>;
 }

package/resources/functions/executions.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"executions.d.mts","sourceRoot":"","sources":["../../src/resources/functions/executions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,kCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;OAKG;IACH,IAAI,CACF,eAAe,EAAE,MAAM,EACvB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,iBAAiB,CAAC;IAQlE;;OAEG;IACH,MAAM,CACJ,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;OAEG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAKhC;;;;OAIG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED,MAAM,MAAM,+BAA+B,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAE/E,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;CACnD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"executions.d.mts","sourceRoot":"","sources":["../../src/resources/functions/executions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,kCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CACF,eAAe,EAAE,MAAM,EACvB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,iBAAiB,CAAC;IAQlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CACJ,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAKhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED,MAAM,MAAM,+BAA+B,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAE/E,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;CACnD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/functions/executions.d.ts

@@ -11,20 +11,126 @@ export declare class Executions extends APIResource {
      *
      * - Requires: `API Tier 1`
      * - Sortable fields: `id`, `created_at`, `updated_at`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/executions/?order_by=order_by&limit=50&cursor=cursor 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
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "function_id": "string",
+     *       "inputs": {},
+     *       "outputs": {},
+     *       "status": "string",
+     *       "started_at": "string",
+     *       "finished_at": "string"
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
      */
     list(functionAPIName: string, query?: ExecutionListParams | null | undefined, options?: RequestOptions): PagePromise<FunctionExecutionsPageCursorURL, FunctionExecution>;
     /**
      * Create a new function execution.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /functions/{function_api_name}/executions/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "inputs": {}
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "function_id": "string",
+     *   "inputs": {},
+     *   "outputs": {},
+     *   "status": "string",
+     *   "started_at": "string",
+     *   "finished_at": "string"
+     * }
+     * ```
      */
     create(functionAPIName: string, body: ExecutionCreateParams, options?: RequestOptions): APIPromise<FunctionExecution>;
     /**
      * Retrieve a specific function execution.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/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",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "function_id": "string",
+     *   "inputs": {},
+     *   "outputs": {},
+     *   "status": "string",
+     *   "started_at": "string",
+     *   "finished_at": "string"
+     * }
+     * ```
      */
     retrieve(executionID: string, params: ExecutionRetrieveParams, options?: RequestOptions): APIPromise<FunctionExecution>;
     /**
      * A list of function execution logs.
      *
      * - Requires: `API Tier 1`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /functions/{function_api_name}/executions/{execution_id}/logs/ 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
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "message": "string",
+     *       "sequence_num": 0,
+     *       "timestamp": "string",
+     *       "level": "string",
+     *       "params": {}
+     *     }
+     *   ]
+     * }
+     * ```
      */
     listLogs(executionID: string, params: ExecutionListLogsParams, options?: RequestOptions): APIPromise<ExecutionListLogsResponse>;
 }

package/resources/functions/executions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"executions.d.ts","sourceRoot":"","sources":["../../src/resources/functions/executions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,iCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;OAKG;IACH,IAAI,CACF,eAAe,EAAE,MAAM,EACvB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,iBAAiB,CAAC;IAQlE;;OAEG;IACH,MAAM,CACJ,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;OAEG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAKhC;;;;OAIG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED,MAAM,MAAM,+BAA+B,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAE/E,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;CACnD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"executions.d.ts","sourceRoot":"","sources":["../../src/resources/functions/executions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,iCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CACF,eAAe,EAAE,MAAM,EACvB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,iBAAiB,CAAC;IAQlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CACJ,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAKhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED,MAAM,MAAM,+BAA+B,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAE/E,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;CACnD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}