@epilot/sdk 2.16.2 → 2.17.0

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"]]],["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]]],["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]]],["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"]}}

package/definitions/file.json

@@ -557,7 +557,7 @@
       "get": {
         "operationId": "downloadFile",
         "summary": "downloadFile",
-        "description": "Generate a pre-signed download URL for a file.\n\nThe returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.\n",
+        "description": "Generate a pre-signed download URL for a file.\n\nThe returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.\n\n**Download attribution (`x-track-*`):** any query parameter whose name starts with\n`x-track-` is treated as opaque tracking metadata and signed into the returned URL, so it\nshows up in the S3 access logs / CloudTrail data events when the link is actually opened.\nThis is a generic, service-agnostic channel — e.g. the customer portal sends\n`x-track-portal-id` and `x-track-contact-id`. Only the `x-track-` namespace is forwarded;\nthe values cannot affect how S3 resolves or serves the object. Parameter names must match\n`^x-track-[a-z0-9](?:[a-z0-9_-]{0,38}[a-z0-9])?$`, values are capped at 256 characters, and\nat most 10 such parameters are honoured (see the `x-track` parameter below).\n",
         "tags": [
           "File"
         ],
@@ -588,6 +588,20 @@
               "type": "boolean",
               "default": true
             }
+          },
+          {
+            "name": "x-track",
+            "in": "query",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "description": "Download-attribution channel. Provide any number of query parameters whose names\nstart with `x-track-` (e.g. `x-track-portal-id`, `x-track-contact-id`); each is signed\ninto the pre-signed URL verbatim so the download is recorded in the S3 access logs /\nCloudTrail data events. Only the `x-track-` namespace is forwarded — values cannot\naffect how S3 resolves or serves the object. Parameter names must match\n`^x-track-[a-z0-9](?:[a-z0-9_-]{0,38}[a-z0-9])?$`, values are capped at 256 characters,\nand at most 10 such parameters are honoured.\n",
+            "schema": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            }
           }
         ],
         "responses": {
@@ -1243,6 +1257,9 @@
           "401": {
             "$ref": "#/components/responses/UnauthorizedError"
           },
+          "403": {
+            "$ref": "#/components/responses/ForbiddenError"
+          },
           "404": {
             "$ref": "#/components/responses/NotFoundError"
           },

package/definitions/focus-pocus-runtime.json

@@ -0,0 +1 @@
+{"s":"https://focus-pocus.dev.sls.epilot.io","o":[["getHealth","get","/v1/health"],["listAchievements","get","/v1/achievements"],["getAchievement","get","/v1/achievements/{id}",[["AchievementOrChallengeId"]]],["getSuggestedChallenge","get","/v1/challenges/suggest",[["route","q"],["entity_type","q"],["category_hint","q"]]],["acceptChallenge","post","/v1/challenges/{id}/accept",[["ChallengeId"]]],["dismissChallenge","post","/v1/challenges/{id}/dismiss",[["ChallengeId"]]],["listActiveChallenges","get","/v1/challenges/active"],["postEvent","post","/v1/events",null,1]],"v":"3.0.3","cp":{"AchievementId":["id","p",true],"AchievementOrChallengeId":["id","p",true],"ChallengeId":["id","p",true],"Cursor":["cursor","q"],"Size":["size","q"]}}