@epilot/cli 0.1.10 → 0.1.12

package/definitions/email-template.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.2",
   "info": {
     "title": "Email template API",
-    "version": "1.0.0-RFC",
+    "version": "1.1.0",
     "description": "Email template API service\n"
   },
   "tags": [
@@ -598,6 +598,10 @@
             "description": "Updated by",
             "type": "string",
             "example": 1234
+          },
+          "json_template": {
+            "type": "string",
+            "description": "This field is used to store JSON templates. If this field is populated, then the Body html is derived from the JSON."
           }
         }
       },
@@ -688,6 +692,10 @@
                 "type": "string",
                 "example": 1234
               },
+              "json_template": {
+                "type": "string",
+                "description": "This field is used to store JSON templates. If this field is populated, then the Body html is derived from the JSON."
+              },
               "system_template": {
                 "description": "If template is created by system (Double Opt-in, CMD invitation,...) then true, and some attributes can not be edited such as Name, To,...\nRemember to add default content of template to system_template enum for revert to original feature\n",
                 "type": "boolean",
@@ -1085,6 +1093,11 @@
         "type": "boolean",
         "description": "When true, it lets to send only the email by skip creating the thread & message entities."
       },
+      "CompleteThread": {
+        "type": "boolean",
+        "description": "Whether the thread is marked as Done immediately after sending the message",
+        "default": false
+      },
       "BulkSendMessageRequest": {
         "type": "object",
         "description": "It takes a list of entity ids, treating each as a separate mainEntity to construct individual messages.\nFor e.g; if there some opportunityIds are provided, then each opportunityId is treated as a separate mainEntity to construct individual messages.\n",
@@ -1096,6 +1109,9 @@
           "skip_creating_entities": {
             "$ref": "#/components/schemas/SkipCreatingEntities"
           },
+          "complete_thread": {
+            "$ref": "#/components/schemas/CompleteThread"
+          },
           "email_template_id": {
             "type": "string",
             "description": "ID of email template to use for sending bulk emails",
@@ -1104,7 +1120,7 @@
           "must_include_unsubscribe_link": {
             "type": "boolean",
             "description": "If true then include unsubscribe link in the email body\n",
-            "default": true
+            "default": false
           },
           "recipient_ids": {
             "type": "array",
@@ -1134,6 +1150,9 @@
           "skip_creating_entities": {
             "$ref": "#/components/schemas/SkipCreatingEntities"
           },
+          "complete_thread": {
+            "$ref": "#/components/schemas/CompleteThread"
+          },
           "email_template_id": {
             "type": "string",
             "description": "ID of email template to use for sending bulk emails",
@@ -1142,7 +1161,7 @@
           "must_include_unsubscribe_link": {
             "type": "boolean",
             "description": "If true then include unsubscribe link in the email body\n",
-            "default": true
+            "default": false
           },
           "recipient_query": {
             "type": "string",
@@ -1192,6 +1211,9 @@
           "skip_creating_entities": {
             "$ref": "#/components/schemas/SkipCreatingEntities"
           },
+          "complete_thread": {
+            "$ref": "#/components/schemas/CompleteThread"
+          },
           "status": {
             "type": "string",
             "description": "Status of the bulk message action\n* PROCESSING: Bulk message action is processing the request\n* QUEUEING: Bulk message action is generating emails to send in a queue\n* SENDING: Bulk message action is sending emails from the queue\n* SUCCESS: Bulk message action is completed successfully\n* FAILED: Bulk message action is failed\n* CANCELLED: Bulk message action was cancelled\n",

package/definitions/entity.json

@@ -66,6 +66,16 @@
             "in": "query",
             "name": "unpublished",
             "description": "Return unpublished draft schemas",
+            "deprecated": true,
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          {
+            "in": "query",
+            "name": "latest",
+            "description": "When true, return the latest version instead of the frozen version for frozen schemas.",
             "schema": {
               "type": "boolean",
               "default": false
@@ -83,6 +93,105 @@
             },
             "style": "form",
             "explode": false
+          },
+          {
+            "in": "query",
+            "name": "include",
+            "description": "List of schema slugs to include in the results. When provided, only these schemas are returned. Accepts a comma-separated list of slugs.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "style": "form",
+            "explode": false
+          }
+        ],
+        "tags": [
+          "Schemas"
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/EntitySchemaItem"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v2/entity/schemas": {
+      "get": {
+        "operationId": "listSchemasV2",
+        "summary": "listSchemasV2",
+        "description": "Get the latest versions of all schemas.\nReturns summary schemas by default (only summary attributes, no capabilities).\nUse ?full=true for complete schemas.\n",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "full",
+            "description": "Return full schemas including all attributes and capabilities",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          {
+            "in": "query",
+            "name": "unpublished",
+            "description": "Return unpublished draft schemas",
+            "deprecated": true,
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          {
+            "in": "query",
+            "name": "latest",
+            "description": "When true, return the latest version instead of the frozen version for frozen schemas.",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          {
+            "in": "query",
+            "name": "exclude",
+            "description": "List of schema slugs to exclude from the results. Accepts a comma-separated list of slugs to exclude from the results.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "style": "form",
+            "explode": false
+          },
+          {
+            "in": "query",
+            "name": "include",
+            "description": "List of schema slugs to include in the results. When provided, only these schemas are returned. Accepts a comma-separated list of slugs.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "style": "form",
+            "explode": false
           }
         ],
         "tags": [
@@ -114,7 +223,7 @@
       "get": {
         "operationId": "getSchema",
         "summary": "getSchema",
-        "description": "By default gets the latest version of the Schema and to get the specific version of schema pass the id.",
+        "description": "By default gets the current version of the Schema (frozen version if frozen, otherwise latest).\nPass ?latest=true to get the latest version when the schema is frozen.\nPass ?id= to get a specific version by ID.\n",
         "tags": [
           "Schemas"
         ],
@@ -128,6 +237,15 @@
             "schema": {
               "$ref": "#/components/schemas/SchemaId"
             }
+          },
+          {
+            "in": "query",
+            "name": "latest",
+            "description": "When true, return the latest version instead of the frozen version for frozen schemas.",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
           }
         ],
         "responses": {
@@ -149,7 +267,7 @@
       "put": {
         "operationId": "putSchema",
         "summary": "putSchema",
-        "description": "Create or update a schema with a new version",
+        "description": "Create or update a schema with a new version.\nWhen the schema is frozen, writes update the latest version without affecting the frozen version.\n",
         "tags": [
           "Schemas"
         ],
@@ -160,6 +278,7 @@
           {
             "in": "query",
             "name": "draft",
+            "deprecated": true,
             "schema": {
               "default": false,
               "type": "boolean"
@@ -657,6 +776,7 @@
                       }
                     },
                     "drafts": {
+                      "deprecated": true,
                       "type": "array",
                       "items": {
                         "$ref": "#/components/schemas/EntitySchemaItem"
@@ -667,8 +787,17 @@
                       "type": "boolean"
                     },
                     "drafts_more": {
+                      "deprecated": true,
                       "description": "Pagination: Whether more drafts are available",
                       "type": "boolean"
+                    },
+                    "frozen_version": {
+                      "description": "The version ID that is currently frozen, if any",
+                      "allOf": [
+                        {
+                          "$ref": "#/components/schemas/SchemaId"
+                        }
+                      ]
                     }
                   },
                   "required": [
@@ -682,6 +811,85 @@
         }
       }
     },
+    "/v1/entity/schemas/{slug}/freeze": {
+      "post": {
+        "operationId": "freezeSchema",
+        "summary": "freezeSchema",
+        "description": "Freeze a schema at its current version, or at a specific version.\nWhen frozen, getSchema returns the frozen version by default.\nNew edits via putSchema update the latest version without affecting the frozen version.\n",
+        "tags": [
+          "Schemas"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntitySlugPathParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "version_id": {
+                    "description": "Freeze to a specific version ID. Defaults to the current version.",
+                    "allOf": [
+                      {
+                        "$ref": "#/components/schemas/SchemaId"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Schema frozen successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntitySchemaItem"
+                }
+              }
+            }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
+          }
+        }
+      }
+    },
+    "/v1/entity/schemas/{slug}/unfreeze": {
+      "post": {
+        "operationId": "unfreezeSchema",
+        "summary": "unfreezeSchema",
+        "description": "Unfreeze a schema. Promotes the latest version to the current version for all users.\n",
+        "tags": [
+          "Schemas"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntitySlugPathParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Schema unfrozen successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntitySchemaItem"
+                }
+              }
+            }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
+          }
+        }
+      }
+    },
     "/v1/entity/schemas/{slug}/capabilities/available": {
       "get": {
         "operationId": "listAvailableCapabilities",
@@ -1673,7 +1881,7 @@
       "post": {
         "operationId": "createActivity",
         "summary": "createActivity",
-        "description": "Create an activity that can be displayed in activity feeds.\n\n- All activites are published as events on the event bus\n- Entity mutations are always part of an activity\n",
+        "description": "Create an activity that can be displayed in activity feeds.\n\n- All activites are published as events on the event bus\n- Entity mutations are always part of an activity\n- When more than 10 entities are passed, the first 10 are attached synchronously and the rest are processed asynchronously to avoid DynamoDB throttling\n",
         "tags": [
           "Activity"
         ],
@@ -3074,7 +3282,7 @@
                       }
                     },
                     "deleted": {
-                      "type": "object",
+                      "type": "array",
                       "items": {
                         "$ref": "#/components/schemas/ClassificationId"
                       }
@@ -3331,6 +3539,34 @@
             "schema": {
               "$ref": "#/components/schemas/TaxonomySearchIncludeArchivedParam"
             }
+          },
+          {
+            "in": "query",
+            "name": "exclude_types",
+            "description": "Taxonomy type(s) to exclude from the results. Useful to filter out relation labels, schema labels, and system labels.\n",
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "enum": [
+                    "relation",
+                    "schema",
+                    "system"
+                  ]
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "enum": [
+                      "relation",
+                      "schema",
+                      "system"
+                    ]
+                  }
+                }
+              ]
+            }
           }
         ],
         "requestBody": {
@@ -4474,6 +4710,7 @@
             "example": false
           },
           "draft": {
+            "deprecated": true,
             "type": "boolean",
             "example": false
           },
@@ -4698,6 +4935,16 @@
               "type": "string"
             }
           },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create the schema",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            },
+            "nullable": true
+          },
           "explicit_search_mappings": {
             "$ref": "#/components/schemas/SearchMappings"
           },
@@ -4743,6 +4990,18 @@
                     "type": "string"
                   }
                 }
+              },
+              "frozen": {
+                "description": "Indicates this schema is currently frozen. Present when the returned version is the frozen version.",
+                "type": "boolean"
+              },
+              "latest": {
+                "description": "Indicates this is the latest version of the schema. Both frozen and latest can be true if no changes were made since freezing.",
+                "type": "boolean"
+              },
+              "_summary": {
+                "description": "Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings)",
+                "type": "boolean"
               }
             }
           },
@@ -5004,6 +5263,9 @@
           {
             "$ref": "#/components/schemas/NumberAttribute"
           },
+          {
+            "$ref": "#/components/schemas/TableAttribute"
+          },
           {
             "$ref": "#/components/schemas/ConsentAttribute"
           },
@@ -5607,6 +5869,11 @@
                   "public-read",
                   "private"
                 ]
+              },
+              "file_size_bytes": {
+                "type": "integer",
+                "description": "The maximum file size in bytes. Used to derive file_size and file_size_unit in the UI.",
+                "example": 5000000
               }
             },
             "required": [
@@ -6244,6 +6511,104 @@
           }
         ]
       },
+      "TableAttribute": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseAttribute"
+          },
+          {
+            "type": "object",
+            "description": "Dynamic data table with configurable columns. Data is stored as an array of objects where each object represents a row.",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "table"
+                ]
+              },
+              "columns": {
+                "type": "array",
+                "description": "Column definitions for the table",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "description": "The column identifier (used as object key in row data)"
+                    },
+                    "label": {
+                      "type": "string",
+                      "description": "Display label for the column header"
+                    },
+                    "type": {
+                      "type": "string",
+                      "description": "The data type for cells in this column",
+                      "enum": [
+                        "string",
+                        "number",
+                        "date",
+                        "boolean"
+                      ],
+                      "default": "string"
+                    },
+                    "width": {
+                      "type": "string",
+                      "description": "Optional column width (e.g., \"100px\", \"20%\")"
+                    },
+                    "required": {
+                      "type": "boolean",
+                      "description": "Whether this column is required for each row",
+                      "default": false
+                    },
+                    "bold": {
+                      "type": "boolean",
+                      "description": "When true, the row is rendered in bold (only applies in transposed mode)",
+                      "default": false
+                    }
+                  },
+                  "required": [
+                    "name",
+                    "label"
+                  ]
+                }
+              },
+              "min_rows": {
+                "type": "integer",
+                "description": "Minimum number of rows required",
+                "minimum": 0,
+                "default": 0
+              },
+              "max_rows": {
+                "type": "integer",
+                "description": "Maximum number of rows allowed (or maximum periods when transposed)",
+                "minimum": 1
+              },
+              "transposed": {
+                "type": "boolean",
+                "description": "Enable transposed layout where rows become metrics and columns become periods",
+                "default": false
+              },
+              "column_header": {
+                "type": "object",
+                "description": "Configuration for column headers in transposed mode",
+                "properties": {
+                  "template": {
+                    "type": "string",
+                    "description": "Header label pattern with {{i}} as index placeholder (e.g., \"Year {{i}}\")",
+                    "example": "Year {{i}}"
+                  },
+                  "start": {
+                    "type": "integer",
+                    "description": "Starting index value for the template placeholder",
+                    "default": 0,
+                    "minimum": 0
+                  }
+                }
+              }
+            }
+          }
+        ]
+      },
       "ConsentAttribute": {
         "allOf": [
           {
@@ -6746,6 +7111,24 @@
             "items": {
               "$ref": "#/components/schemas/SettingFlag"
             }
+          },
+          "schemas": {
+            "type": "array",
+            "description": "Schema-specific configuration for the capability",
+            "items": {
+              "type": "object",
+              "additionalProperties": true,
+              "required": [
+                "schema"
+              ],
+              "properties": {
+                "schema": {
+                  "type": "string",
+                  "description": "Entity schema slug",
+                  "example": "contact"
+                }
+              }
+            }
           }
         },
         "required": [
@@ -7070,10 +7453,13 @@
         }
       },
       "NullableEntity": {
-        "nullable": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/Entity"
+          },
+          {
+            "type": "object",
+            "nullable": true
           }
         ]
       },
@@ -8467,6 +8853,20 @@
                 ]
               }
             }
+          },
+          "_workflow_origin": {
+            "type": "object",
+            "description": "Internal property for workflow origin tracking and infinite loop prevention.\nPopulated when an entity update originates from a workflow execution.\nThis allows downstream automation services to prevent circular triggering.\n",
+            "properties": {
+              "workflow_exec_id": {
+                "type": "string",
+                "description": "The ID of the workflow execution that triggered this entity update"
+              },
+              "flow_template_id": {
+                "type": "string",
+                "description": "The flow template ID - used to detect and prevent circular triggering"
+              }
+            }
           }
         },
         "required": [