@roarkanalytics/sdk 2.34.0 → 3.0.0

package/resources/customer-flow-edge-case.js

@@ -10,6 +10,15 @@ class CustomerFlowEdgeCase extends resource_1.APIResource {
      * expectations. Omitted fields are left alone; `additionalExpectations` replaces
      * the set wholesale rather than appending. Promoting it to the happy path is a
      * separate call, since that also demotes the incumbent.
+     *
+     * @example
+     * ```ts
+     * const customerFlowEdgeCase =
+     *   await client.customerFlowEdgeCase.update(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     { flowId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     *   );
+     * ```
      */
     update(edgeCaseID, params, options) {
         const { flowId, ...body } = params;
@@ -23,6 +32,14 @@ class CustomerFlowEdgeCase extends resource_1.APIResource {
      * /v1/customer-flow/{flowId}/graph rather than here.
      *
      * Leave personaOverrideId or environmentId unset to inherit the happy path's.
+     *
+     * @example
+     * ```ts
+     * const response = await client.customerFlowEdgeCase.add(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { title: 'x' },
+     * );
+     * ```
      */
     add(flowID, body, options) {
         return this._client.post((0, path_1.path) `/v1/customer-flow/${flowID}/edge-case`, { body, ...options });
@@ -31,6 +48,14 @@ class CustomerFlowEdgeCase extends resource_1.APIResource {
      * Makes this edge case the flow's happy path, and the outgoing happy path an edge
      * case. Its persona and environment are baked into it first, so edge cases that
      * were inheriting keep the configuration they had.
+     *
+     * @example
+     * ```ts
+     * const response = await client.customerFlowEdgeCase.promote(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { flowId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     * );
+     * ```
      */
     promote(edgeCaseID, params, options) {
         const { flowId } = params;
@@ -40,6 +65,15 @@ class CustomerFlowEdgeCase extends resource_1.APIResource {
      * Soft-deletes a variant. On a scripted flow the path engine re-creates a variant
      * for any path still in the graph, so remove the path through PUT /graph instead
      * if that is what you meant.
+     *
+     * @example
+     * ```ts
+     * const customerFlowEdgeCase =
+     *   await client.customerFlowEdgeCase.remove(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     { flowId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     *   );
+     * ```
      */
     remove(edgeCaseID, params, options) {
         const { flowId } = params;

package/resources/customer-flow-edge-case.js.map

@@ -1 +1 @@
-{"version":3,"file":"customer-flow-edge-case.js","sourceRoot":"","sources":["../src/resources/customer-flow-edge-case.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;;OAKG;IACH,MAAM,CACJ,UAAkB,EAClB,MAAwC,EACxC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,MAAM,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CACD,MAAc,EACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,MAAM,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;OAIG;IACH,OAAO,CACL,UAAkB,EAClB,MAAyC,EACzC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,MAAM,cAAc,UAAU,UAAU,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,UAAkB,EAClB,MAAwC,EACxC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,MAAM,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;CACF;AA5DD,oDA4DC"}
+{"version":3,"file":"customer-flow-edge-case.js","sourceRoot":"","sources":["../src/resources/customer-flow-edge-case.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAkB,EAClB,MAAwC,EACxC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,MAAM,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CACD,MAAc,EACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,MAAM,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,UAAkB,EAClB,MAAyC,EACzC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,MAAM,cAAc,UAAU,UAAU,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,UAAkB,EAClB,MAAwC,EACxC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,MAAM,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;CACF;AA9FD,oDA8FC"}

package/resources/customer-flow-edge-case.mjs

@@ -7,6 +7,15 @@ export class CustomerFlowEdgeCase extends APIResource {
      * expectations. Omitted fields are left alone; `additionalExpectations` replaces
      * the set wholesale rather than appending. Promoting it to the happy path is a
      * separate call, since that also demotes the incumbent.
+     *
+     * @example
+     * ```ts
+     * const customerFlowEdgeCase =
+     *   await client.customerFlowEdgeCase.update(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     { flowId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     *   );
+     * ```
      */
     update(edgeCaseID, params, options) {
         const { flowId, ...body } = params;
@@ -20,6 +29,14 @@ export class CustomerFlowEdgeCase extends APIResource {
      * /v1/customer-flow/{flowId}/graph rather than here.
      *
      * Leave personaOverrideId or environmentId unset to inherit the happy path's.
+     *
+     * @example
+     * ```ts
+     * const response = await client.customerFlowEdgeCase.add(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { title: 'x' },
+     * );
+     * ```
      */
     add(flowID, body, options) {
         return this._client.post(path `/v1/customer-flow/${flowID}/edge-case`, { body, ...options });
@@ -28,6 +45,14 @@ export class CustomerFlowEdgeCase extends APIResource {
      * Makes this edge case the flow's happy path, and the outgoing happy path an edge
      * case. Its persona and environment are baked into it first, so edge cases that
      * were inheriting keep the configuration they had.
+     *
+     * @example
+     * ```ts
+     * const response = await client.customerFlowEdgeCase.promote(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { flowId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     * );
+     * ```
      */
     promote(edgeCaseID, params, options) {
         const { flowId } = params;
@@ -37,6 +62,15 @@ export class CustomerFlowEdgeCase extends APIResource {
      * Soft-deletes a variant. On a scripted flow the path engine re-creates a variant
      * for any path still in the graph, so remove the path through PUT /graph instead
      * if that is what you meant.
+     *
+     * @example
+     * ```ts
+     * const customerFlowEdgeCase =
+     *   await client.customerFlowEdgeCase.remove(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     { flowId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     *   );
+     * ```
      */
     remove(edgeCaseID, params, options) {
         const { flowId } = params;

package/resources/customer-flow-edge-case.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"customer-flow-edge-case.mjs","sourceRoot":"","sources":["../src/resources/customer-flow-edge-case.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;;;;OAKG;IACH,MAAM,CACJ,UAAkB,EAClB,MAAwC,EACxC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,MAAM,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CACD,MAAc,EACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,MAAM,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;OAIG;IACH,OAAO,CACL,UAAkB,EAClB,MAAyC,EACzC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,MAAM,cAAc,UAAU,UAAU,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,UAAkB,EAClB,MAAwC,EACxC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,MAAM,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;CACF"}
+{"version":3,"file":"customer-flow-edge-case.mjs","sourceRoot":"","sources":["../src/resources/customer-flow-edge-case.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAkB,EAClB,MAAwC,EACxC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,MAAM,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CACD,MAAc,EACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,MAAM,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,UAAkB,EAClB,MAAyC,EACzC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,MAAM,cAAc,UAAU,UAAU,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,UAAkB,EAClB,MAAwC,EACxC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,MAAM,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;CACF"}