@epilot/sdk 2.20.8 → 2.20.10

package/definitions/file-runtime.json

@@ -1 +1 @@
-{"s":"https://file.sls.epilot.io","o":[["uploadFileV2","post","/v2/files/upload",[["file_entity_id","q"]],1],["saveFileV2","post","/v2/files",[["ActivityIdQueryParam"],["FillActivityQueryParam"],["StrictQueryParam"],["AsyncOperationQueryParam"],["DeleteTempFileQueryParam"],["VersionOnlyQueryParam"]],1],["uploadFile","post","/v1/files/upload",[["file_entity_id","q"]],1],["saveFile","post","/v1/files",[["ActivityIdQueryParam"],["AsyncOperationQueryParam"],["VersionOnlyQueryParam"]],1],["getFile","get","/v2/files/{id}",[["id","p",true],["source_url","q"],["StrictQueryParam"],["AsyncOperationQueryParam"]]],["deleteFile","delete","/v2/files/{id}",[["id","p",true],["purge","q"],["ActivityIdQueryParam"],["StrictQueryParam"]]],["downloadFile","get","/v1/files/{id}/download",[["id","p",true],["version","q"],["attachment","q"],["x-track","q",false,"form",true]]],["downloadS3File","post","/v1/files:downloadS3",[["s3_key","q",true],["s3_bucket","q",true],["attachment","q"]]],["downloadFiles","post","/v1/files:downloadFiles",null,1],["createZipJob","post","/v1/files:zipJob",null,1],["getZipJob","get","/v1/files:zipJob/{job_id}",[["job_id","p",true]]],["getFileSummary","get","/v1/files/{id}/summary",[["id","p",true]]],["getFileSummaryFeedback","get","/v1/files/{id}/summary/feedback",[["id","p",true]]],["putFileSummaryFeedback","put","/v1/files/{id}/summary/feedback",[["id","p",true]],1],["createFileSummaryJob","post","/v1/files/{id}/summary-jobs",[["id","p",true]]],["getCurrentFileSummaryJob","get","/v1/files/{id}/summary-jobs/current",[["id","p",true]]],["getFileSummaryJob","get","/v1/files/{id}/summary-jobs/{job_id}",[["id","p",true],["job_id","p",true]]],["generateFileSummary","post","/v1/files/{id}/summary:generate",[["id","p",true]]],["getFileText","get","/v1/files/{id}/text",[["id","p",true]]],["previewFile","get","/v1/files/{id}/preview",[["id","p",true],["version","q"],["w","q"],["h","q"]]],["previewS3File","post","/v1/files:previewS3",[["w","q"],["h","q"]],1],["previewS3FileGet","get","/v1/files:previewS3",[["key","q",true],["bucket","q",true],["w","q"],["h","q"]]],["previewPublicFile","get","/v1/files/public/{id}/preview",[["id","p",true],["version","q"],["w","q"],["h","q"],["org_id","q"]]],["getSession","get","/v1/files/session"],["deleteSession","delete","/v1/files/session"],["generatePublicLink","post","/v1/files/{id}/public/links",[["id","p",true]]],["listPublicLinksForFile","get","/v1/files/{id}/public/links",[["id","p",true]]],["accessPublicLink","get","/v1/files/public/links/{id}/{filename}",[["id","p",true],["filename","p",true],["hash","q"]]],["revokePublicLink","delete","/v1/files/public/links/{id}",[["id","p",true]]],["verifyCustomDownloadUrl","post","/v1/files/download:verify",null,1],["uploadFilePublic","post","/v1/files/public/upload",null,1],["getUserSchemaFileCollections","get","/v1/{slug}/collections",[["slug","p",true]]],["createUserSchemaFileCollection","post","/v1/{slug}/collections",[["slug","p",true]],1],["updateUserSchemaFileCollection","put","/v1/{slug}/collections/{collectionSlug}",[["slug","p",true],["collectionSlug","p",true]],1],["deleteUserSchemaFileCollection","delete","/v1/{slug}/collections/{collectionSlug}",[["slug","p",true],["collectionSlug","p",true]]],["getFilesInCollection","get","/v1/entity/{id}/collections/{collectionSlug}/files",[["EntityIdPathParam"],["collectionSlug","p",true]]],["getGlobalFileCollections","get","/v1/collections/{schemaSlug}",[["schemaSlug","p",true]]]],"v":"3.0.3","cp":{"EntityIdPathParam":["id","p",true],"StrictQueryParam":["strict","q"],"ActivityIdQueryParam":["activity_id","q"],"FillActivityQueryParam":["fill_activity","q"],"AsyncOperationQueryParam":["async","q"],"DeleteTempFileQueryParam":["delete_temp_file","q"],"VersionOnlyQueryParam":["version_only","q"]}}
+{"s":"https://file.sls.epilot.io","o":[["uploadFileV2","post","/v2/files/upload",[["file_entity_id","q"]],1],["saveFileV2","post","/v2/files",[["ActivityIdQueryParam"],["FillActivityQueryParam"],["StrictQueryParam"],["AsyncOperationQueryParam"],["DeleteTempFileQueryParam"],["VersionOnlyQueryParam"]],1],["uploadFile","post","/v1/files/upload",[["file_entity_id","q"]],1],["saveFile","post","/v1/files",[["ActivityIdQueryParam"],["AsyncOperationQueryParam"],["VersionOnlyQueryParam"]],1],["getFile","get","/v2/files/{id}",[["id","p",true],["source_url","q"],["StrictQueryParam"],["AsyncOperationQueryParam"]]],["deleteFile","delete","/v2/files/{id}",[["id","p",true],["purge","q"],["ActivityIdQueryParam"],["StrictQueryParam"]]],["downloadFile","get","/v1/files/{id}/download",[["id","p",true],["version","q"],["attachment","q"],["x-track","q",false,"form",true]]],["downloadS3File","post","/v1/files:downloadS3",[["s3_key","q",true],["s3_bucket","q",true],["attachment","q"]]],["downloadFiles","post","/v1/files:downloadFiles",null,1],["createZipJob","post","/v1/files:zipJob",null,1],["getZipJob","get","/v1/files:zipJob/{job_id}",[["job_id","p",true]]],["getFileSummary","get","/v1/files/{id}/summary",[["id","p",true]]],["getFileSummaryFeedback","get","/v1/files/{id}/summary/feedback",[["id","p",true]]],["putFileSummaryFeedback","put","/v1/files/{id}/summary/feedback",[["id","p",true]],1],["createFileSummaryJob","post","/v1/files/{id}/summary-jobs",[["id","p",true]]],["getCurrentFileSummaryJob","get","/v1/files/{id}/summary-jobs/current",[["id","p",true]]],["getFileSummaryJob","get","/v1/files/{id}/summary-jobs/{job_id}",[["id","p",true],["job_id","p",true]]],["generateFileSummary","post","/v1/files/{id}/summary:generate",[["id","p",true]]],["getFileText","get","/v1/files/{id}/text",[["id","p",true]]],["validateFile","post","/v1/files/validations",null,1],["previewFile","get","/v1/files/{id}/preview",[["id","p",true],["version","q"],["w","q"],["h","q"]]],["previewS3File","post","/v1/files:previewS3",[["w","q"],["h","q"]],1],["previewS3FileGet","get","/v1/files:previewS3",[["key","q",true],["bucket","q",true],["w","q"],["h","q"]]],["previewPublicFile","get","/v1/files/public/{id}/preview",[["id","p",true],["version","q"],["w","q"],["h","q"],["org_id","q"]]],["getSession","get","/v1/files/session"],["deleteSession","delete","/v1/files/session"],["generatePublicLink","post","/v1/files/{id}/public/links",[["id","p",true]]],["listPublicLinksForFile","get","/v1/files/{id}/public/links",[["id","p",true]]],["accessPublicLink","get","/v1/files/public/links/{id}/{filename}",[["id","p",true],["filename","p",true],["hash","q"]]],["revokePublicLink","delete","/v1/files/public/links/{id}",[["id","p",true]]],["verifyCustomDownloadUrl","post","/v1/files/download:verify",null,1],["uploadFilePublic","post","/v1/files/public/upload",null,1],["getUserSchemaFileCollections","get","/v1/{slug}/collections",[["slug","p",true]]],["createUserSchemaFileCollection","post","/v1/{slug}/collections",[["slug","p",true]],1],["updateUserSchemaFileCollection","put","/v1/{slug}/collections/{collectionSlug}",[["slug","p",true],["collectionSlug","p",true]],1],["deleteUserSchemaFileCollection","delete","/v1/{slug}/collections/{collectionSlug}",[["slug","p",true],["collectionSlug","p",true]]],["getFilesInCollection","get","/v1/entity/{id}/collections/{collectionSlug}/files",[["EntityIdPathParam"],["collectionSlug","p",true]]],["getGlobalFileCollections","get","/v1/collections/{schemaSlug}",[["schemaSlug","p",true]]]],"v":"3.0.3","cp":{"EntityIdPathParam":["id","p",true],"StrictQueryParam":["strict","q"],"ActivityIdQueryParam":["activity_id","q"],"FillActivityQueryParam":["fill_activity","q"],"AsyncOperationQueryParam":["async","q"],"DeleteTempFileQueryParam":["delete_temp_file","q"],"VersionOnlyQueryParam":["version_only","q"]}}

package/definitions/file.json

@@ -124,6 +124,9 @@
           "401": {
             "$ref": "#/components/responses/UnauthorizedError"
           },
+          "422": {
+            "$ref": "#/components/responses/UnprocessableEntityError"
+          },
           "500": {
             "$ref": "#/components/responses/InternalServerError"
           }
@@ -281,6 +284,9 @@
           "404": {
             "$ref": "#/components/responses/NotFoundError"
           },
+          "422": {
+            "$ref": "#/components/responses/UnprocessableEntityError"
+          },
           "500": {
             "$ref": "#/components/responses/InternalServerError"
           }
@@ -366,6 +372,9 @@
           "401": {
             "$ref": "#/components/responses/UnauthorizedError"
           },
+          "422": {
+            "$ref": "#/components/responses/UnprocessableEntityError"
+          },
           "500": {
             "$ref": "#/components/responses/InternalServerError"
           }
@@ -431,6 +440,9 @@
           "401": {
             "$ref": "#/components/responses/UnauthorizedError"
           },
+          "422": {
+            "$ref": "#/components/responses/UnprocessableEntityError"
+          },
           "500": {
             "$ref": "#/components/responses/InternalServerError"
           }
@@ -1297,6 +1309,73 @@
         }
       }
     },
+    "/v1/files/validations": {
+      "post": {
+        "operationId": "validateFile",
+        "summary": "validateFile",
+        "description": "Validate an uploaded file against one or more document validation rules\n(validation-rules-api rules with `input_type: document`).\n\nThe file is referenced either by its file entity id or, for an upload that has not been\nsaved as an entity yet (e.g. a journey upload in the temporary prefix), by its S3 reference.\nThe service collects an observation of the file - deterministic facts such as the sniffed\nmime type, size, page count, image resolution, blank and password-protection detection -\nand evaluates every rule against it with the shared validation rules engine.\n\nThe response carries one result per rule with a per-condition outcome (`pass`, `fail`,\n`uncertain`, `skipped`), plus the observation the results were derived from. `status` is\n`completed` for checks that finish synchronously; `pending` is reserved for check levels\nthat need asynchronous content extraction.\n",
+        "tags": [
+          "File"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/FileValidationRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The validation result",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FileValidation"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequestError"
+          },
+          "401": {
+            "$ref": "#/components/responses/UnauthorizedError"
+          },
+          "403": {
+            "$ref": "#/components/responses/ForbiddenError"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
+          },
+          "413": {
+            "description": "The file is too large to validate",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorObject"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "The file could not be read",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorObject"
+                }
+              }
+            }
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v1/files/{id}/preview": {
       "get": {
         "operationId": "previewFile",
@@ -2090,6 +2169,9 @@
           "400": {
             "$ref": "#/components/responses/BadRequestError"
           },
+          "422": {
+            "$ref": "#/components/responses/UnprocessableEntityError"
+          },
           "500": {
             "$ref": "#/components/responses/InternalServerError"
           }
@@ -2806,6 +2888,296 @@
         ],
         "readOnly": true
       },
+      "FileValidationRequest": {
+        "type": "object",
+        "required": [
+          "file",
+          "rule_ids"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "file": {
+            "$ref": "#/components/schemas/FileValidationFileReference"
+          },
+          "rule_ids": {
+            "type": "array",
+            "description": "Document validation rules to evaluate. Rules of another input type are rejected.",
+            "minItems": 1,
+            "maxItems": 10,
+            "uniqueItems": true,
+            "items": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        }
+      },
+      "FileValidationFileReference": {
+        "description": "The file to validate - a saved file entity, or an uploaded object not saved as an entity yet.",
+        "oneOf": [
+          {
+            "type": "object",
+            "required": [
+              "entity_id"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "entity_id": {
+                "$ref": "#/components/schemas/FileEntityId"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "s3ref"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "s3ref": {
+                "$ref": "#/components/schemas/S3Ref"
+              }
+            }
+          }
+        ]
+      },
+      "FileValidation": {
+        "type": "object",
+        "required": [
+          "id",
+          "status",
+          "file",
+          "observation",
+          "results",
+          "created_at"
+        ],
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Identifier of this validation run."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "completed",
+              "pending",
+              "failed"
+            ],
+            "description": "`completed` when every rule was evaluated. `pending` is reserved for check levels that\nneed asynchronous content extraction; `failed` when the observation could not be produced.\n"
+          },
+          "file": {
+            "$ref": "#/components/schemas/FileValidationFile"
+          },
+          "observation": {
+            "$ref": "#/components/schemas/FileValidationObservation"
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/FileValidationRuleResult"
+            }
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          }
+        }
+      },
+      "FileValidationFile": {
+        "type": "object",
+        "description": "The file that was validated, with the identity facts collected from its content.",
+        "properties": {
+          "entity_id": {
+            "$ref": "#/components/schemas/FileEntityId"
+          },
+          "s3ref": {
+            "$ref": "#/components/schemas/S3Ref"
+          },
+          "filename": {
+            "type": "string"
+          },
+          "mime_type": {
+            "type": "string",
+            "description": "Mime type detected from the file content, falling back to the declared type."
+          },
+          "size_bytes": {
+            "type": "integer"
+          }
+        }
+      },
+      "FileValidationObservation": {
+        "type": "object",
+        "description": "Everything observed about the file, as passed to the validation rules engine.",
+        "required": [
+          "facts"
+        ],
+        "properties": {
+          "facts": {
+            "$ref": "#/components/schemas/FileValidationFacts"
+          },
+          "judgements": {
+            "type": "object",
+            "description": "Content judgements keyed by condition id, produced by the document requirements\ncheck for `meetsCriteria` conditions at the `standard` and `advanced` levels.\nAbsent when no content check ran (basic level, unsupported file, or the check\ndid not finish within its budget).\n",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/FileValidationJudgement"
+            }
+          },
+          "document_type": {
+            "type": "object",
+            "description": "Document type detected by the content check, when it ran.",
+            "properties": {
+              "slug": {
+                "type": "string"
+              },
+              "confidence": {
+                "type": "number"
+              }
+            }
+          }
+        }
+      },
+      "FileValidationJudgement": {
+        "type": "object",
+        "required": [
+          "result"
+        ],
+        "properties": {
+          "result": {
+            "type": "string",
+            "enum": [
+              "pass",
+              "fail",
+              "uncertain"
+            ]
+          },
+          "confidence": {
+            "type": "number"
+          },
+          "evidence": {
+            "type": "string"
+          },
+          "explanation": {
+            "type": "string"
+          }
+        }
+      },
+      "FileValidationFacts": {
+        "type": "object",
+        "description": "Deterministic properties of the file. A property that is absent could not be determined\n(for example the resolution of an image the service cannot decode); conditions that need it\nare skipped rather than failed.\n",
+        "properties": {
+          "mime_type": {
+            "type": "string"
+          },
+          "size_bytes": {
+            "type": "integer"
+          },
+          "page_count": {
+            "type": "integer",
+            "description": "Pages of a PDF; 1 for images."
+          },
+          "longer_edge_px": {
+            "type": "integer",
+            "description": "Longer edge of an image in pixels."
+          },
+          "is_blank": {
+            "type": "boolean"
+          },
+          "is_password_protected": {
+            "type": "boolean"
+          }
+        }
+      },
+      "FileValidationRuleResult": {
+        "type": "object",
+        "required": [
+          "rule_id",
+          "level",
+          "is_valid",
+          "conditions"
+        ],
+        "properties": {
+          "rule_id": {
+            "type": "string"
+          },
+          "rule_title": {
+            "type": "string"
+          },
+          "level": {
+            "type": "string",
+            "enum": [
+              "basic",
+              "standard",
+              "advanced"
+            ],
+            "description": "The rule's check level."
+          },
+          "is_valid": {
+            "type": "boolean",
+            "description": "True when every blocking condition passed or was skipped."
+          },
+          "failed_parts": {
+            "type": "array",
+            "description": "Error messages of blocking conditions that failed.",
+            "items": {
+              "type": "string"
+            }
+          },
+          "warnings": {
+            "type": "array",
+            "description": "Error messages of advisory conditions that failed and of uncertain judgements.",
+            "items": {
+              "type": "string"
+            }
+          },
+          "conditions": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/FileValidationConditionResult"
+            }
+          }
+        }
+      },
+      "FileValidationConditionResult": {
+        "type": "object",
+        "required": [
+          "id",
+          "operator",
+          "outcome",
+          "blocking",
+          "message"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "operator": {
+            "type": "string"
+          },
+          "outcome": {
+            "type": "string",
+            "enum": [
+              "pass",
+              "fail",
+              "uncertain",
+              "skipped"
+            ]
+          },
+          "blocking": {
+            "type": "boolean",
+            "description": "True when this outcome makes the file invalid."
+          },
+          "message": {
+            "type": "string",
+            "description": "The condition's configured error message."
+          },
+          "evidence": {
+            "type": "string"
+          },
+          "explanation": {
+            "type": "string"
+          }
+        }
+      },
       "FileText": {
         "type": "object",
         "properties": {
@@ -3795,6 +4167,26 @@
           }
         }
       },
+      "UnprocessableEntityError": {
+        "description": "The request was well-formed but the file's type or content is not acceptable",
+        "content": {
+          "application/json": {
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/ErrorObject"
+                },
+                {
+                  "example": {
+                    "status": 422,
+                    "error": "File type not allowed"
+                  }
+                }
+              ]
+            }
+          }
+        }
+      },
       "UnauthorizedError": {
         "description": "Authentication required or invalid credentials",
         "content": {

package/definitions/journey-runtime.json

@@ -1 +1 @@
-{"s":"https://journey-config.sls.epilot.io","o":[["getJourneysByOrgId","get","/v1/journey/organization/{id}",[["id","p",true],["hydrate","q"]]],["getJourney","get","/v1/journey/configuration/{id}",[["id","p",true],["version","q"],["source","q"],["orgId","q"]]],["removeJourney","delete","/v1/journey/configuration/{id}",[["id","p",true]]],["getJourneyEnvironment","get","/v1/journey/configuration/{id}/environment",[["id","p",true]]],["getJourneyEnvironmentVariables","get","/v1/journey/environment-variables"],["getJourneyProducts","get","/v1/journey/products/{id}",[["id","p",true],["source","q"],["postal_code","q"],["city","q"],["street","q"],["street_number","q"]]],["createJourney","post","/v1/journey/configuration",[["skipAutomation","q"]],1],["updateJourney","put","/v1/journey/configuration",null,1],["patchUpdateJourney","patch","/v1/journey/configuration",null,1],["searchJourneys","post","/v1/journey/configuration/search",null,1],["generateDocument","post","/v1/journey/document:generate",null,1],["createJourneyV2","post","/v2/journey/configuration",[["skipAutomation","q"]],1],["updateJourneyV2","put","/v2/journey/configuration",null,1],["patchUpdateJourneyV2","patch","/v2/journey/configuration",null,1],["getJourneyV2","get","/v2/journey/configuration/{id}",[["id","p",true],["version","q"]]],["removeJourneyV2","delete","/v2/journey/configuration/{id}",[["id","p",true]]],["getSettingsForJourney","get","/v1/journey/{id}/settings",[["id","p",true]]],["getButtonOptions","get","/v1/journey/button-options",[["fileId","q",true]]]],"v":"3.0.0"}
+{"s":"https://journey-config.sls.epilot.io","o":[["getJourneysByOrgId","get","/v1/journey/organization/{id}",[["id","p",true],["hydrate","q"]]],["getJourney","get","/v1/journey/configuration/{id}",[["id","p",true],["version","q"],["source","q"],["orgId","q"]]],["removeJourney","delete","/v1/journey/configuration/{id}",[["id","p",true]]],["createJourneyRevision","post","/v1/journey/configuration/{id}/revisions",[["id","p",true]],1],["listJourneyRevisions","get","/v1/journey/configuration/{id}/revisions",[["id","p",true],["limit","q"],["cursor","q"]]],["getJourneyRevision","get","/v1/journey/configuration/{id}/revisions/{revision_id}",[["id","p",true],["revision_id","p",true]]],["publishJourneyRevision","post","/v1/journey/configuration/{id}/publish",[["id","p",true]],1],["getJourneyPublishState","get","/v1/journey/configuration/{id}/publish-state",[["id","p",true]]],["getJourneyEnvironment","get","/v1/journey/configuration/{id}/environment",[["id","p",true]]],["getJourneyEnvironmentVariables","get","/v1/journey/environment-variables"],["getJourneyProducts","get","/v1/journey/products/{id}",[["id","p",true],["source","q"],["postal_code","q"],["city","q"],["street","q"],["street_number","q"]]],["createJourney","post","/v1/journey/configuration",[["skipAutomation","q"]],1],["updateJourney","put","/v1/journey/configuration",null,1],["patchUpdateJourney","patch","/v1/journey/configuration",null,1],["searchJourneys","post","/v1/journey/configuration/search",null,1],["generateDocument","post","/v1/journey/document:generate",null,1],["createJourneyV2","post","/v2/journey/configuration",[["skipAutomation","q"]],1],["updateJourneyV2","put","/v2/journey/configuration",null,1],["patchUpdateJourneyV2","patch","/v2/journey/configuration",null,1],["getJourneyV2","get","/v2/journey/configuration/{id}",[["id","p",true],["version","q"]]],["removeJourneyV2","delete","/v2/journey/configuration/{id}",[["id","p",true]]],["getSettingsForJourney","get","/v1/journey/{id}/settings",[["id","p",true]]],["getButtonOptions","get","/v1/journey/button-options",[["fileId","q",true]]]],"v":"3.0.0"}