@zyphr-dev/node-sdk 0.1.17 → 0.1.19

package/dist/index.js

@@ -2653,6 +2653,352 @@ function EndUserDeleteResponseToJSONTyped(value, ignoreDiscriminator = false) {
   };
 }
 
+// src/src/models/ExecutionCancelResponseData.ts
+var ExecutionCancelResponseDataStatusEnum = {
+  CANCELLED: "cancelled"
+};
+function instanceOfExecutionCancelResponseData(value) {
+  return true;
+}
+function ExecutionCancelResponseDataFromJSON(json) {
+  return ExecutionCancelResponseDataFromJSONTyped(json, false);
+}
+function ExecutionCancelResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "id": json["id"] == null ? void 0 : json["id"],
+    "status": json["status"] == null ? void 0 : json["status"]
+  };
+}
+function ExecutionCancelResponseDataToJSON(json) {
+  return ExecutionCancelResponseDataToJSONTyped(json, false);
+}
+function ExecutionCancelResponseDataToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "id": value["id"],
+    "status": value["status"]
+  };
+}
+
+// src/src/models/ExecutionCancelResponse.ts
+function instanceOfExecutionCancelResponse(value) {
+  return true;
+}
+function ExecutionCancelResponseFromJSON(json) {
+  return ExecutionCancelResponseFromJSONTyped(json, false);
+}
+function ExecutionCancelResponseFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "data": json["data"] == null ? void 0 : ExecutionCancelResponseDataFromJSON(json["data"]),
+    "meta": json["meta"] == null ? void 0 : RequestMetaFromJSON(json["meta"])
+  };
+}
+function ExecutionCancelResponseToJSON(json) {
+  return ExecutionCancelResponseToJSONTyped(json, false);
+}
+function ExecutionCancelResponseToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "data": ExecutionCancelResponseDataToJSON(value["data"]),
+    "meta": RequestMetaToJSON(value["meta"])
+  };
+}
+
+// src/src/models/WorkflowExecutionStatus.ts
+var WorkflowExecutionStatus = {
+  PENDING: "pending",
+  RUNNING: "running",
+  COMPLETED: "completed",
+  FAILED: "failed",
+  CANCELLED: "cancelled"
+};
+function instanceOfWorkflowExecutionStatus(value) {
+  for (const key in WorkflowExecutionStatus) {
+    if (Object.prototype.hasOwnProperty.call(WorkflowExecutionStatus, key)) {
+      if (WorkflowExecutionStatus[key] === value) {
+        return true;
+      }
+    }
+  }
+  return false;
+}
+function WorkflowExecutionStatusFromJSON(json) {
+  return WorkflowExecutionStatusFromJSONTyped(json, false);
+}
+function WorkflowExecutionStatusFromJSONTyped(json, ignoreDiscriminator) {
+  return json;
+}
+function WorkflowExecutionStatusToJSON(value) {
+  return value;
+}
+function WorkflowExecutionStatusToJSONTyped(value, ignoreDiscriminator) {
+  return value;
+}
+
+// src/src/models/WorkflowStepExecutionStatus.ts
+var WorkflowStepExecutionStatus = {
+  PENDING: "pending",
+  RUNNING: "running",
+  COMPLETED: "completed",
+  SKIPPED: "skipped",
+  FAILED: "failed",
+  WAITING: "waiting"
+};
+function instanceOfWorkflowStepExecutionStatus(value) {
+  for (const key in WorkflowStepExecutionStatus) {
+    if (Object.prototype.hasOwnProperty.call(WorkflowStepExecutionStatus, key)) {
+      if (WorkflowStepExecutionStatus[key] === value) {
+        return true;
+      }
+    }
+  }
+  return false;
+}
+function WorkflowStepExecutionStatusFromJSON(json) {
+  return WorkflowStepExecutionStatusFromJSONTyped(json, false);
+}
+function WorkflowStepExecutionStatusFromJSONTyped(json, ignoreDiscriminator) {
+  return json;
+}
+function WorkflowStepExecutionStatusToJSON(value) {
+  return value;
+}
+function WorkflowStepExecutionStatusToJSONTyped(value, ignoreDiscriminator) {
+  return value;
+}
+
+// src/src/models/WorkflowStepExecution.ts
+var WorkflowStepExecutionStepTypeEnum = {
+  EMAIL: "email",
+  PUSH: "push",
+  SMS: "sms",
+  IN_APP: "in_app",
+  SLACK: "slack",
+  DISCORD: "discord",
+  TEAMS: "teams",
+  DELAY: "delay",
+  BRANCH: "branch"
+};
+function instanceOfWorkflowStepExecution(value) {
+  if (!("id" in value) || value["id"] === void 0) return false;
+  if (!("executionId" in value) || value["executionId"] === void 0) return false;
+  if (!("stepId" in value) || value["stepId"] === void 0) return false;
+  if (!("status" in value) || value["status"] === void 0) return false;
+  if (!("createdAt" in value) || value["createdAt"] === void 0) return false;
+  return true;
+}
+function WorkflowStepExecutionFromJSON(json) {
+  return WorkflowStepExecutionFromJSONTyped(json, false);
+}
+function WorkflowStepExecutionFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "id": json["id"],
+    "executionId": json["execution_id"],
+    "stepId": json["step_id"],
+    "status": WorkflowStepExecutionStatusFromJSON(json["status"]),
+    "result": json["result"] == null ? void 0 : json["result"],
+    "startedAt": json["started_at"] == null ? void 0 : new Date(json["started_at"]),
+    "completedAt": json["completed_at"] == null ? void 0 : new Date(json["completed_at"]),
+    "error": json["error"] == null ? void 0 : json["error"],
+    "createdAt": new Date(json["created_at"]),
+    "stepKey": json["step_key"] == null ? void 0 : json["step_key"],
+    "stepName": json["step_name"] == null ? void 0 : json["step_name"],
+    "stepType": json["step_type"] == null ? void 0 : json["step_type"]
+  };
+}
+function WorkflowStepExecutionToJSON(json) {
+  return WorkflowStepExecutionToJSONTyped(json, false);
+}
+function WorkflowStepExecutionToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "id": value["id"],
+    "execution_id": value["executionId"],
+    "step_id": value["stepId"],
+    "status": WorkflowStepExecutionStatusToJSON(value["status"]),
+    "result": value["result"],
+    "started_at": value["startedAt"] == null ? void 0 : value["startedAt"].toISOString(),
+    "completed_at": value["completedAt"] == null ? void 0 : value["completedAt"].toISOString(),
+    "error": value["error"],
+    "created_at": value["createdAt"].toISOString(),
+    "step_key": value["stepKey"],
+    "step_name": value["stepName"],
+    "step_type": value["stepType"]
+  };
+}
+
+// src/src/models/WorkflowExecution.ts
+function instanceOfWorkflowExecution(value) {
+  if (!("id" in value) || value["id"] === void 0) return false;
+  if (!("workflowId" in value) || value["workflowId"] === void 0) return false;
+  if (!("accountId" in value) || value["accountId"] === void 0) return false;
+  if (!("projectId" in value) || value["projectId"] === void 0) return false;
+  if (!("subscriberId" in value) || value["subscriberId"] === void 0) return false;
+  if (!("status" in value) || value["status"] === void 0) return false;
+  if (!("createdAt" in value) || value["createdAt"] === void 0) return false;
+  return true;
+}
+function WorkflowExecutionFromJSON(json) {
+  return WorkflowExecutionFromJSONTyped(json, false);
+}
+function WorkflowExecutionFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "id": json["id"],
+    "workflowId": json["workflow_id"],
+    "accountId": json["account_id"],
+    "projectId": json["project_id"],
+    "subscriberId": json["subscriber_id"],
+    "topicKey": json["topic_key"] == null ? void 0 : json["topic_key"],
+    "triggerPayload": json["trigger_payload"] == null ? void 0 : json["trigger_payload"],
+    "transactionId": json["transaction_id"] == null ? void 0 : json["transaction_id"],
+    "senderFrom": json["sender_from"] == null ? void 0 : json["sender_from"],
+    "status": WorkflowExecutionStatusFromJSON(json["status"]),
+    "currentStepId": json["current_step_id"] == null ? void 0 : json["current_step_id"],
+    "stepExecutions": json["step_executions"] == null ? void 0 : json["step_executions"].map(WorkflowStepExecutionFromJSON),
+    "startedAt": json["started_at"] == null ? void 0 : new Date(json["started_at"]),
+    "completedAt": json["completed_at"] == null ? void 0 : new Date(json["completed_at"]),
+    "createdAt": new Date(json["created_at"])
+  };
+}
+function WorkflowExecutionToJSON(json) {
+  return WorkflowExecutionToJSONTyped(json, false);
+}
+function WorkflowExecutionToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "id": value["id"],
+    "workflow_id": value["workflowId"],
+    "account_id": value["accountId"],
+    "project_id": value["projectId"],
+    "subscriber_id": value["subscriberId"],
+    "topic_key": value["topicKey"],
+    "trigger_payload": value["triggerPayload"],
+    "transaction_id": value["transactionId"],
+    "sender_from": value["senderFrom"],
+    "status": WorkflowExecutionStatusToJSON(value["status"]),
+    "current_step_id": value["currentStepId"],
+    "step_executions": value["stepExecutions"] == null ? void 0 : value["stepExecutions"].map(WorkflowStepExecutionToJSON),
+    "started_at": value["startedAt"] == null ? void 0 : value["startedAt"].toISOString(),
+    "completed_at": value["completedAt"] == null ? void 0 : value["completedAt"].toISOString(),
+    "created_at": value["createdAt"].toISOString()
+  };
+}
+
+// src/src/models/ExecutionResponse.ts
+function instanceOfExecutionResponse(value) {
+  return true;
+}
+function ExecutionResponseFromJSON(json) {
+  return ExecutionResponseFromJSONTyped(json, false);
+}
+function ExecutionResponseFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "data": json["data"] == null ? void 0 : WorkflowExecutionFromJSON(json["data"]),
+    "meta": json["meta"] == null ? void 0 : RequestMetaFromJSON(json["meta"])
+  };
+}
+function ExecutionResponseToJSON(json) {
+  return ExecutionResponseToJSONTyped(json, false);
+}
+function ExecutionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "data": WorkflowExecutionToJSON(value["data"]),
+    "meta": RequestMetaToJSON(value["meta"])
+  };
+}
+
+// src/src/models/ExecutionRetryResponseData.ts
+var ExecutionRetryResponseDataStatusEnum = {
+  PENDING: "pending"
+};
+function instanceOfExecutionRetryResponseData(value) {
+  if (!("id" in value) || value["id"] === void 0) return false;
+  if (!("originalExecutionId" in value) || value["originalExecutionId"] === void 0) return false;
+  if (!("status" in value) || value["status"] === void 0) return false;
+  return true;
+}
+function ExecutionRetryResponseDataFromJSON(json) {
+  return ExecutionRetryResponseDataFromJSONTyped(json, false);
+}
+function ExecutionRetryResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "id": json["id"],
+    "originalExecutionId": json["original_execution_id"],
+    "status": json["status"]
+  };
+}
+function ExecutionRetryResponseDataToJSON(json) {
+  return ExecutionRetryResponseDataToJSONTyped(json, false);
+}
+function ExecutionRetryResponseDataToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "id": value["id"],
+    "original_execution_id": value["originalExecutionId"],
+    "status": value["status"]
+  };
+}
+
+// src/src/models/ExecutionRetryResponse.ts
+function instanceOfExecutionRetryResponse(value) {
+  return true;
+}
+function ExecutionRetryResponseFromJSON(json) {
+  return ExecutionRetryResponseFromJSONTyped(json, false);
+}
+function ExecutionRetryResponseFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "data": json["data"] == null ? void 0 : ExecutionRetryResponseDataFromJSON(json["data"]),
+    "meta": json["meta"] == null ? void 0 : RequestMetaFromJSON(json["meta"])
+  };
+}
+function ExecutionRetryResponseToJSON(json) {
+  return ExecutionRetryResponseToJSONTyped(json, false);
+}
+function ExecutionRetryResponseToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "data": ExecutionRetryResponseDataToJSON(value["data"]),
+    "meta": RequestMetaToJSON(value["meta"])
+  };
+}
+
 // src/src/models/ForgotPasswordRequest.ts
 function instanceOfForgotPasswordRequest(value) {
   if (!("email" in value) || value["email"] === void 0) return false;
@@ -13354,6 +13700,106 @@ var ListEmailsStatusEnum = {
   REJECTED: "rejected"
 };
 
+// src/src/apis/ExecutionsApi.ts
+var ExecutionsApi = class extends BaseAPI {
+  /**
+   * Cancel a workflow execution that is still pending or running. Already-terminal executions cannot be cancelled.
+   * Cancel a running execution
+   */
+  async cancelExecutionRaw(requestParameters, initOverrides) {
+    if (requestParameters["id"] == null) {
+      throw new RequiredError(
+        "id",
+        'Required parameter "id" was null or undefined when calling cancelExecution().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key");
+    }
+    const response = await this.request({
+      path: `/executions/{id}/cancel`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters["id"]))),
+      method: "POST",
+      headers: headerParameters,
+      query: queryParameters
+    }, initOverrides);
+    return new JSONApiResponse(response, (jsonValue) => ExecutionCancelResponseFromJSON(jsonValue));
+  }
+  /**
+   * Cancel a workflow execution that is still pending or running. Already-terminal executions cannot be cancelled.
+   * Cancel a running execution
+   */
+  async cancelExecution(id, initOverrides) {
+    const response = await this.cancelExecutionRaw({ id }, initOverrides);
+    return await response.value();
+  }
+  /**
+   * Retrieve a workflow execution by ID, including its step execution details.
+   * Get a workflow execution
+   */
+  async getExecutionRaw(requestParameters, initOverrides) {
+    if (requestParameters["id"] == null) {
+      throw new RequiredError(
+        "id",
+        'Required parameter "id" was null or undefined when calling getExecution().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key");
+    }
+    const response = await this.request({
+      path: `/executions/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters["id"]))),
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    }, initOverrides);
+    return new JSONApiResponse(response, (jsonValue) => ExecutionResponseFromJSON(jsonValue));
+  }
+  /**
+   * Retrieve a workflow execution by ID, including its step execution details.
+   * Get a workflow execution
+   */
+  async getExecution(id, initOverrides) {
+    const response = await this.getExecutionRaw({ id }, initOverrides);
+    return await response.value();
+  }
+  /**
+   * Create a new workflow execution that re-runs the same workflow with the original subscriber, payload, and sender. Only `failed` or `cancelled` executions can be retried.
+   * Retry a failed or cancelled execution
+   */
+  async retryExecutionRaw(requestParameters, initOverrides) {
+    if (requestParameters["id"] == null) {
+      throw new RequiredError(
+        "id",
+        'Required parameter "id" was null or undefined when calling retryExecution().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key");
+    }
+    const response = await this.request({
+      path: `/executions/{id}/retry`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters["id"]))),
+      method: "POST",
+      headers: headerParameters,
+      query: queryParameters
+    }, initOverrides);
+    return new JSONApiResponse(response, (jsonValue) => ExecutionRetryResponseFromJSON(jsonValue));
+  }
+  /**
+   * Create a new workflow execution that re-runs the same workflow with the original subscriber, payload, and sender. Only `failed` or `cancelled` executions can be retried.
+   * Retry a failed or cancelled execution
+   */
+  async retryExecution(id, initOverrides) {
+    const response = await this.retryExecutionRaw({ id }, initOverrides);
+    return await response.value();
+  }
+};
+
 // src/src/apis/InboxApi.ts
 var InboxApi = class extends BaseAPI {
   /**
@@ -18285,6 +18731,29 @@ export {
   EndUserDeleteResponseFromJSONTyped,
   EndUserDeleteResponseToJSON,
   EndUserDeleteResponseToJSONTyped,
+  ExecutionCancelResponseDataFromJSON,
+  ExecutionCancelResponseDataFromJSONTyped,
+  ExecutionCancelResponseDataStatusEnum,
+  ExecutionCancelResponseDataToJSON,
+  ExecutionCancelResponseDataToJSONTyped,
+  ExecutionCancelResponseFromJSON,
+  ExecutionCancelResponseFromJSONTyped,
+  ExecutionCancelResponseToJSON,
+  ExecutionCancelResponseToJSONTyped,
+  ExecutionResponseFromJSON,
+  ExecutionResponseFromJSONTyped,
+  ExecutionResponseToJSON,
+  ExecutionResponseToJSONTyped,
+  ExecutionRetryResponseDataFromJSON,
+  ExecutionRetryResponseDataFromJSONTyped,
+  ExecutionRetryResponseDataStatusEnum,
+  ExecutionRetryResponseDataToJSON,
+  ExecutionRetryResponseDataToJSONTyped,
+  ExecutionRetryResponseFromJSON,
+  ExecutionRetryResponseFromJSONTyped,
+  ExecutionRetryResponseToJSON,
+  ExecutionRetryResponseToJSONTyped,
+  ExecutionsApi,
   FetchError,
   ForgotPasswordRequestFromJSON,
   ForgotPasswordRequestFromJSONTyped,
@@ -19428,6 +19897,25 @@ export {
   WithdrawSubscriberConsentRequestFromJSONTyped,
   WithdrawSubscriberConsentRequestToJSON,
   WithdrawSubscriberConsentRequestToJSONTyped,
+  WorkflowExecutionFromJSON,
+  WorkflowExecutionFromJSONTyped,
+  WorkflowExecutionStatus,
+  WorkflowExecutionStatusFromJSON,
+  WorkflowExecutionStatusFromJSONTyped,
+  WorkflowExecutionStatusToJSON,
+  WorkflowExecutionStatusToJSONTyped,
+  WorkflowExecutionToJSON,
+  WorkflowExecutionToJSONTyped,
+  WorkflowStepExecutionFromJSON,
+  WorkflowStepExecutionFromJSONTyped,
+  WorkflowStepExecutionStatus,
+  WorkflowStepExecutionStatusFromJSON,
+  WorkflowStepExecutionStatusFromJSONTyped,
+  WorkflowStepExecutionStatusToJSON,
+  WorkflowStepExecutionStatusToJSONTyped,
+  WorkflowStepExecutionStepTypeEnum,
+  WorkflowStepExecutionToJSON,
+  WorkflowStepExecutionToJSONTyped,
   Zyphr,
   ZyphrAuthenticationError,
   ZyphrError,
@@ -19501,6 +19989,11 @@ export {
   instanceOfEmailTrackingResponse,
   instanceOfEndUserDeleteResponse,
   instanceOfEndUserDeleteResponseData,
+  instanceOfExecutionCancelResponse,
+  instanceOfExecutionCancelResponseData,
+  instanceOfExecutionResponse,
+  instanceOfExecutionRetryResponse,
+  instanceOfExecutionRetryResponseData,
   instanceOfForgotPasswordRequest,
   instanceOfGenerateSubscriberToken200Response,
   instanceOfGenerateSubscriberToken200ResponseData,
@@ -19771,6 +20264,10 @@ export {
   instanceOfWebhookVersionsResponse,
   instanceOfWebhookVersionsResponseData,
   instanceOfWithdrawSubscriberConsentRequest,
+  instanceOfWorkflowExecution,
+  instanceOfWorkflowExecutionStatus,
+  instanceOfWorkflowStepExecution,
+  instanceOfWorkflowStepExecutionStatus,
   mapValues,
   parseErrorResponse,
   querystring