@epilot/sdk 2.20.80 → 2.20.81

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/definitions/file-runtime.json +1 -1
  2. package/definitions/file.json +834 -9
  3. package/dist/apis/access-token.cjs +6 -6
  4. package/dist/apis/access-token.js +1 -1
  5. package/dist/apis/address-suggestions.cjs +6 -6
  6. package/dist/apis/address-suggestions.js +1 -1
  7. package/dist/apis/address.cjs +6 -6
  8. package/dist/apis/address.js +1 -1
  9. package/dist/apis/ai-agents.cjs +6 -6
  10. package/dist/apis/ai-agents.js +1 -1
  11. package/dist/apis/app.cjs +6 -6
  12. package/dist/apis/app.js +1 -1
  13. package/dist/apis/audit-logs.cjs +6 -6
  14. package/dist/apis/audit-logs.js +1 -1
  15. package/dist/apis/automation.cjs +6 -6
  16. package/dist/apis/automation.js +1 -1
  17. package/dist/apis/billing.cjs +6 -6
  18. package/dist/apis/billing.js +1 -1
  19. package/dist/apis/blueprint-manifest.cjs +6 -6
  20. package/dist/apis/blueprint-manifest.js +1 -1
  21. package/dist/apis/calendar.cjs +6 -6
  22. package/dist/apis/calendar.js +1 -1
  23. package/dist/apis/chat.cjs +6 -6
  24. package/dist/apis/chat.js +1 -1
  25. package/dist/apis/configuration-hub.cjs +6 -6
  26. package/dist/apis/configuration-hub.js +1 -1
  27. package/dist/apis/consent.cjs +6 -6
  28. package/dist/apis/consent.js +1 -1
  29. package/dist/apis/customer-portal.cjs +6 -6
  30. package/dist/apis/customer-portal.js +1 -1
  31. package/dist/apis/dashboard.cjs +6 -6
  32. package/dist/apis/dashboard.js +1 -1
  33. package/dist/apis/data-governance.cjs +6 -6
  34. package/dist/apis/data-governance.js +1 -1
  35. package/dist/apis/deduplication.cjs +6 -6
  36. package/dist/apis/deduplication.js +1 -1
  37. package/dist/apis/design.cjs +6 -6
  38. package/dist/apis/design.js +1 -1
  39. package/dist/apis/document.cjs +6 -6
  40. package/dist/apis/document.js +1 -1
  41. package/dist/apis/email-settings.cjs +6 -6
  42. package/dist/apis/email-settings.js +1 -1
  43. package/dist/apis/email-template.cjs +6 -6
  44. package/dist/apis/email-template.js +1 -1
  45. package/dist/apis/entity-mapping.cjs +6 -6
  46. package/dist/apis/entity-mapping.js +1 -1
  47. package/dist/apis/entity.cjs +6 -6
  48. package/dist/apis/entity.js +1 -1
  49. package/dist/apis/environments.cjs +6 -6
  50. package/dist/apis/environments.js +1 -1
  51. package/dist/apis/event-catalog.cjs +6 -6
  52. package/dist/apis/event-catalog.js +1 -1
  53. package/dist/apis/external-values.cjs +6 -6
  54. package/dist/apis/external-values.js +1 -1
  55. package/dist/apis/file.cjs +8 -8
  56. package/dist/apis/file.d.cts +2 -2
  57. package/dist/apis/file.d.ts +2 -2
  58. package/dist/apis/file.js +2 -2
  59. package/dist/apis/iban.cjs +6 -6
  60. package/dist/apis/iban.js +1 -1
  61. package/dist/apis/identity.cjs +6 -6
  62. package/dist/apis/identity.js +1 -1
  63. package/dist/apis/integration-toolkit.cjs +6 -6
  64. package/dist/apis/integration-toolkit.js +1 -1
  65. package/dist/apis/journey.cjs +6 -6
  66. package/dist/apis/journey.js +1 -1
  67. package/dist/apis/kanban.cjs +6 -6
  68. package/dist/apis/kanban.js +1 -1
  69. package/dist/apis/message.cjs +6 -6
  70. package/dist/apis/message.js +1 -1
  71. package/dist/apis/metering.cjs +6 -6
  72. package/dist/apis/metering.js +1 -1
  73. package/dist/apis/notes.cjs +6 -6
  74. package/dist/apis/notes.js +1 -1
  75. package/dist/apis/notification.cjs +6 -6
  76. package/dist/apis/notification.js +1 -1
  77. package/dist/apis/organization.cjs +6 -6
  78. package/dist/apis/organization.js +1 -1
  79. package/dist/apis/partner-directory.cjs +6 -6
  80. package/dist/apis/partner-directory.js +1 -1
  81. package/dist/apis/permissions.cjs +6 -6
  82. package/dist/apis/permissions.js +1 -1
  83. package/dist/apis/phone-integration.cjs +6 -6
  84. package/dist/apis/phone-integration.js +1 -1
  85. package/dist/apis/pricing-tier.cjs +6 -6
  86. package/dist/apis/pricing-tier.js +1 -1
  87. package/dist/apis/pricing.cjs +6 -6
  88. package/dist/apis/pricing.js +1 -1
  89. package/dist/apis/purpose.cjs +6 -6
  90. package/dist/apis/purpose.js +1 -1
  91. package/dist/apis/query.cjs +6 -6
  92. package/dist/apis/query.js +1 -1
  93. package/dist/apis/sandbox.cjs +6 -6
  94. package/dist/apis/sandbox.js +1 -1
  95. package/dist/apis/sharing.cjs +6 -6
  96. package/dist/apis/sharing.js +1 -1
  97. package/dist/apis/snapshot.cjs +6 -6
  98. package/dist/apis/snapshot.js +1 -1
  99. package/dist/apis/submission.cjs +6 -6
  100. package/dist/apis/submission.js +1 -1
  101. package/dist/apis/target.cjs +6 -6
  102. package/dist/apis/target.js +1 -1
  103. package/dist/apis/targeting.cjs +6 -6
  104. package/dist/apis/targeting.js +1 -1
  105. package/dist/apis/template-variables.cjs +6 -6
  106. package/dist/apis/template-variables.js +1 -1
  107. package/dist/apis/user.cjs +6 -6
  108. package/dist/apis/user.js +1 -1
  109. package/dist/apis/validation-rules.cjs +6 -6
  110. package/dist/apis/validation-rules.js +1 -1
  111. package/dist/apis/webhooks.cjs +6 -6
  112. package/dist/apis/webhooks.js +1 -1
  113. package/dist/apis/workflow-definition.cjs +6 -6
  114. package/dist/apis/workflow-definition.js +1 -1
  115. package/dist/apis/workflow.cjs +6 -6
  116. package/dist/apis/workflow.js +1 -1
  117. package/dist/{chunk-KH4BRB6Z.js → chunk-2PFXDXXZ.js} +2 -2
  118. package/dist/{chunk-OLRBYITL.cjs → chunk-3PQISQCY.cjs} +2 -2
  119. package/dist/chunk-4HTTGQEJ.cjs +14 -0
  120. package/dist/chunk-IWKGR2GI.js +14 -0
  121. package/dist/file-3MIGWJIS.cjs +7 -0
  122. package/dist/file-LA7WL5QQ.js +7 -0
  123. package/dist/{file-runtime-RS4DX5LB.js → file-runtime-JOWOEQD2.js} +1 -1
  124. package/dist/file-runtime-LBP7QFAO.cjs +5 -0
  125. package/dist/{file.d-DELNV63w.d.cts → file.d-BIakPRHY.d.cts} +556 -3
  126. package/dist/{file.d-DELNV63w.d.ts → file.d-BIakPRHY.d.ts} +556 -3
  127. package/dist/index.cjs +10 -10
  128. package/dist/index.d.cts +1 -1
  129. package/dist/index.d.ts +1 -1
  130. package/dist/index.js +2 -2
  131. package/docs/file.md +344 -0
  132. package/package.json +1 -1
  133. package/dist/chunk-424JLS5G.cjs +0 -14
  134. package/dist/chunk-FGQBS7TA.js +0 -14
  135. package/dist/file-2KT6MMMG.cjs +0 -7
  136. package/dist/file-N3SGGI6E.js +0 -7
  137. package/dist/file-runtime-JL2IZ2CE.cjs +0 -5
@@ -78,6 +78,7 @@ declare namespace Components {
78
78
  */
79
79
  error?: string;
80
80
  }
81
+ export type FileAttributeSuggestionErrorResponse = /* A generic error returned by the API */ Schemas.FileAttributeSuggestionError;
81
82
  /**
82
83
  * A generic error returned by the API
83
84
  * example:
@@ -276,6 +277,18 @@ declare namespace Components {
276
277
  */
277
278
  relations?: FileRelationItem[];
278
279
  }
280
+ export interface CreateFileAttributeSuggestionJobRequest {
281
+ /**
282
+ * Schema slug of the entity to suggest values for
283
+ * example:
284
+ * opportunity
285
+ */
286
+ entity_slug: string; // ^[a-zA-Z0-9_-]+$
287
+ /**
288
+ * The entity to suggest values for
289
+ */
290
+ entity_id: string; // uuid
291
+ }
279
292
  /**
280
293
  * Request payload to create a ZIP job for bulk file download.
281
294
  * Provide either an explicit list of `file_entity_ids` (up to 1000) or an
@@ -2422,6 +2435,118 @@ declare namespace Components {
2422
2435
  */
2423
2436
  error?: string;
2424
2437
  }
2438
+ export interface FileAttributeSuggestion {
2439
+ /**
2440
+ * Schema attribute name (field key on the entity)
2441
+ */
2442
+ attribute_name?: string;
2443
+ /**
2444
+ * Human readable attribute label
2445
+ */
2446
+ attribute_label?: string;
2447
+ attribute_type?: "date" | "number" | "boolean" | "select" | "string";
2448
+ /**
2449
+ * Scalar matching the attribute schema. Dates as `YYYY-MM-DD`.
2450
+ */
2451
+ suggested_value?: /* Scalar matching the attribute schema. Dates as `YYYY-MM-DD`. */ string | number | boolean;
2452
+ confidence?: "high" | "medium" | "low";
2453
+ /**
2454
+ * Page number in the document where the value was found
2455
+ */
2456
+ source_page?: number;
2457
+ /**
2458
+ * Quote from the document followed by a short explanation of the mapping
2459
+ */
2460
+ evidence?: string;
2461
+ status?: "suggested" | "accepted" | "discarded";
2462
+ /**
2463
+ * User id that last updated the suggestion status
2464
+ */
2465
+ status_updated_by?: string;
2466
+ /**
2467
+ * Epoch milliseconds of the last status update
2468
+ */
2469
+ status_updated_at?: number;
2470
+ /**
2471
+ * Reason given when the suggestion was discarded
2472
+ */
2473
+ discard_reason?: string;
2474
+ /**
2475
+ * Whether a user copied the suggested value
2476
+ */
2477
+ is_copied?: boolean;
2478
+ /**
2479
+ * User id that copied the suggested value
2480
+ */
2481
+ copied_by?: string;
2482
+ /**
2483
+ * Epoch milliseconds when the value was copied
2484
+ */
2485
+ copied_at?: number;
2486
+ /**
2487
+ * `new_value` when the entity field is empty, `update` when the suggestion proposes a change
2488
+ */
2489
+ suggestion_type?: "new_value" | "update";
2490
+ }
2491
+ /**
2492
+ * A generic error returned by the API
2493
+ */
2494
+ export interface FileAttributeSuggestionError {
2495
+ /**
2496
+ * The HTTP status code of the error
2497
+ * example:
2498
+ * 400
2499
+ */
2500
+ status?: number;
2501
+ /**
2502
+ * The error message
2503
+ * example:
2504
+ * Bad Request
2505
+ */
2506
+ error?: string;
2507
+ error_code?: "entity_or_schema_unavailable" | "file_not_extracted" | "extraction_unsupported" | "extraction_failed" | "extraction_status_unavailable" | "processing_enqueue_failed" | "no_file_attribute_suggestions_job" | "job_not_found";
2508
+ }
2509
+ export interface FileAttributeSuggestionJob {
2510
+ /**
2511
+ * Attribute suggestion job ID (ULID)
2512
+ */
2513
+ jobId: string;
2514
+ jobStatus: FileAttributeSuggestionJobStatus;
2515
+ payload: FileAttributeSuggestionsPayload;
2516
+ /**
2517
+ * Epoch milliseconds
2518
+ */
2519
+ createdAt: number;
2520
+ /**
2521
+ * Epoch milliseconds
2522
+ */
2523
+ updatedAt: number;
2524
+ }
2525
+ export interface FileAttributeSuggestionJobStatus {
2526
+ status: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
2527
+ /**
2528
+ * Progress in percent (0-100)
2529
+ */
2530
+ progress: number;
2531
+ /**
2532
+ * Failure reason when status is FAILED
2533
+ */
2534
+ error?: string;
2535
+ }
2536
+ export interface FileAttributeSuggestionsPayload {
2537
+ file_id: string;
2538
+ entity_id: string;
2539
+ entity_slug: string;
2540
+ /**
2541
+ * User id that requested the job
2542
+ */
2543
+ generated_by?: string;
2544
+ /**
2545
+ * Epoch milliseconds when the job was requested
2546
+ */
2547
+ generated_at?: number;
2548
+ suggestions: FileAttributeSuggestion[];
2549
+ }
2425
2550
  export interface FileAttributes {
2426
2551
  /**
2427
2552
  * example:
@@ -2937,10 +3062,12 @@ declare namespace Components {
2937
3062
  id: string;
2938
3063
  /**
2939
3064
  * `completed` when every rule was evaluated. `pending` is reserved for check levels that
2940
- * need asynchronous content extraction; `failed` when the observation could not be produced.
3065
+ * need asynchronous content extraction; `failed` when the observation could not be produced;
3066
+ * `skipped` when document validation is not enabled for the organisation - the file was not
3067
+ * read and `results` is empty, so callers treat the file as accepted.
2941
3068
  *
2942
3069
  */
2943
- status: "completed" | "pending" | "failed";
3070
+ status: "completed" | "pending" | "failed" | "skipped";
2944
3071
  file: /* The file that was validated, with the identity facts collected from its content. */ FileValidationFile;
2945
3072
  observation: /* Everything observed about the file, as passed to the validation rules engine. */ FileValidationObservation;
2946
3073
  results: FileValidationRuleResult[];
@@ -3461,6 +3588,68 @@ declare namespace Components {
3461
3588
  file_summary_execution_id?: string; // uuid
3462
3589
  s3ref?: S3Ref;
3463
3590
  }
3591
+ export interface UpdateFileAttributeSuggestionStatusRequest {
3592
+ suggestionStatusUpdates: [
3593
+ ({
3594
+ /**
3595
+ * The attribute_name of the suggestion to update
3596
+ */
3597
+ attribute_name: string;
3598
+ status: "accepted" | "discarded";
3599
+ /**
3600
+ * Set to true when the user copied the suggested value
3601
+ */
3602
+ is_copied?: boolean;
3603
+ /**
3604
+ * Optional reason when status is discarded
3605
+ */
3606
+ discard_reason?: string;
3607
+ } | {
3608
+ /**
3609
+ * The attribute_name of the suggestion to update
3610
+ */
3611
+ attribute_name: string;
3612
+ status?: "accepted" | "discarded";
3613
+ /**
3614
+ * Set to true when the user copied the suggested value
3615
+ */
3616
+ is_copied: boolean;
3617
+ /**
3618
+ * Optional reason when status is discarded
3619
+ */
3620
+ discard_reason?: string;
3621
+ }),
3622
+ ...({
3623
+ /**
3624
+ * The attribute_name of the suggestion to update
3625
+ */
3626
+ attribute_name: string;
3627
+ status: "accepted" | "discarded";
3628
+ /**
3629
+ * Set to true when the user copied the suggested value
3630
+ */
3631
+ is_copied?: boolean;
3632
+ /**
3633
+ * Optional reason when status is discarded
3634
+ */
3635
+ discard_reason?: string;
3636
+ } | {
3637
+ /**
3638
+ * The attribute_name of the suggestion to update
3639
+ */
3640
+ attribute_name: string;
3641
+ status?: "accepted" | "discarded";
3642
+ /**
3643
+ * Set to true when the user copied the suggested value
3644
+ */
3645
+ is_copied: boolean;
3646
+ /**
3647
+ * Optional reason when status is discarded
3648
+ */
3649
+ discard_reason?: string;
3650
+ })[]
3651
+ ];
3652
+ }
3464
3653
  export interface UploadFilePayload {
3465
3654
  /**
3466
3655
  * example:
@@ -3628,6 +3817,45 @@ declare namespace Paths {
3628
3817
  Components.Responses.InternalServerError;
3629
3818
  }
3630
3819
  }
3820
+ namespace CreateFileAttributeSuggestionJob {
3821
+ namespace Parameters {
3822
+ export type Id = /**
3823
+ * example:
3824
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
3825
+ */
3826
+ Components.Schemas.FileEntityId;
3827
+ }
3828
+ export interface PathParameters {
3829
+ id: Parameters.Id;
3830
+ }
3831
+ export type RequestBody = Components.Schemas.CreateFileAttributeSuggestionJobRequest;
3832
+ namespace Responses {
3833
+ export type $202 = Components.Schemas.FileAttributeSuggestionJob;
3834
+ export type $400 = Components.Responses.FileAttributeSuggestionErrorResponse;
3835
+ export type $401 = /**
3836
+ * A generic error returned by the API
3837
+ * example:
3838
+ * {
3839
+ * "status": 401,
3840
+ * "error": "Unauthorized: Invalid or expired token"
3841
+ * }
3842
+ */
3843
+ Components.Responses.UnauthorizedError;
3844
+ export type $403 = /**
3845
+ * A generic error returned by the API
3846
+ * example:
3847
+ * {
3848
+ * "status": 403,
3849
+ * "error": "Forbidden: You do not have permission to access this file"
3850
+ * }
3851
+ */
3852
+ Components.Responses.ForbiddenError;
3853
+ export type $404 = Components.Responses.FileAttributeSuggestionErrorResponse;
3854
+ export type $422 = Components.Responses.FileAttributeSuggestionErrorResponse;
3855
+ export type $500 = Components.Responses.FileAttributeSuggestionErrorResponse;
3856
+ export type $503 = Components.Responses.FileAttributeSuggestionErrorResponse;
3857
+ }
3858
+ }
3631
3859
  namespace CreateFileSummaryJob {
3632
3860
  namespace Parameters {
3633
3861
  export type Id = /**
@@ -3755,6 +3983,15 @@ declare namespace Paths {
3755
3983
  * }
3756
3984
  */
3757
3985
  Components.Responses.UnauthorizedError;
3986
+ export type $403 = /**
3987
+ * A generic error returned by the API
3988
+ * example:
3989
+ * {
3990
+ * "status": 403,
3991
+ * "error": "Forbidden: You do not have permission to access this file"
3992
+ * }
3993
+ */
3994
+ Components.Responses.ForbiddenError;
3758
3995
  export type $500 = /**
3759
3996
  * A generic error returned by the API
3760
3997
  * example:
@@ -4295,6 +4532,51 @@ declare namespace Paths {
4295
4532
  Components.Responses.InternalServerError;
4296
4533
  }
4297
4534
  }
4535
+ namespace GetFileAttributeSuggestionJob {
4536
+ namespace Parameters {
4537
+ export type Id = /**
4538
+ * example:
4539
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
4540
+ */
4541
+ Components.Schemas.FileEntityId;
4542
+ export type JobId = string;
4543
+ }
4544
+ export interface PathParameters {
4545
+ id: Parameters.Id;
4546
+ job_id: Parameters.JobId;
4547
+ }
4548
+ namespace Responses {
4549
+ export type $200 = Components.Schemas.FileAttributeSuggestionJob;
4550
+ export type $401 = /**
4551
+ * A generic error returned by the API
4552
+ * example:
4553
+ * {
4554
+ * "status": 401,
4555
+ * "error": "Unauthorized: Invalid or expired token"
4556
+ * }
4557
+ */
4558
+ Components.Responses.UnauthorizedError;
4559
+ export type $403 = /**
4560
+ * A generic error returned by the API
4561
+ * example:
4562
+ * {
4563
+ * "status": 403,
4564
+ * "error": "Forbidden: You do not have permission to access this file"
4565
+ * }
4566
+ */
4567
+ Components.Responses.ForbiddenError;
4568
+ export type $404 = Components.Responses.FileAttributeSuggestionErrorResponse;
4569
+ export type $500 = /**
4570
+ * A generic error returned by the API
4571
+ * example:
4572
+ * {
4573
+ * "status": 500,
4574
+ * "error": "Internal Server Error"
4575
+ * }
4576
+ */
4577
+ Components.Responses.InternalServerError;
4578
+ }
4579
+ }
4298
4580
  namespace GetFileSummary {
4299
4581
  namespace Parameters {
4300
4582
  export type Id = /**
@@ -4603,6 +4885,62 @@ declare namespace Paths {
4603
4885
  Components.Responses.InternalServerError;
4604
4886
  }
4605
4887
  }
4888
+ namespace GetLatestFileAttributeSuggestions {
4889
+ namespace Parameters {
4890
+ export type EntityId = string; // uuid
4891
+ export type Id = /**
4892
+ * example:
4893
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
4894
+ */
4895
+ Components.Schemas.FileEntityId;
4896
+ }
4897
+ export interface PathParameters {
4898
+ id: Parameters.Id;
4899
+ }
4900
+ export interface QueryParameters {
4901
+ entity_id: Parameters.EntityId /* uuid */;
4902
+ }
4903
+ namespace Responses {
4904
+ export type $200 = Components.Schemas.FileAttributeSuggestionJob;
4905
+ export type $400 = /**
4906
+ * A generic error returned by the API
4907
+ * example:
4908
+ * {
4909
+ * "status": 400,
4910
+ * "error": "Bad Request: filename is required"
4911
+ * }
4912
+ */
4913
+ Components.Responses.BadRequestError;
4914
+ export type $401 = /**
4915
+ * A generic error returned by the API
4916
+ * example:
4917
+ * {
4918
+ * "status": 401,
4919
+ * "error": "Unauthorized: Invalid or expired token"
4920
+ * }
4921
+ */
4922
+ Components.Responses.UnauthorizedError;
4923
+ export type $403 = /**
4924
+ * A generic error returned by the API
4925
+ * example:
4926
+ * {
4927
+ * "status": 403,
4928
+ * "error": "Forbidden: You do not have permission to access this file"
4929
+ * }
4930
+ */
4931
+ Components.Responses.ForbiddenError;
4932
+ export type $404 = Components.Responses.FileAttributeSuggestionErrorResponse;
4933
+ export type $500 = /**
4934
+ * A generic error returned by the API
4935
+ * example:
4936
+ * {
4937
+ * "status": 500,
4938
+ * "error": "Internal Server Error"
4939
+ * }
4940
+ */
4941
+ Components.Responses.InternalServerError;
4942
+ }
4943
+ }
4606
4944
  namespace GetSession {
4607
4945
  namespace Responses {
4608
4946
  export interface $200 {
@@ -4696,6 +5034,24 @@ declare namespace Paths {
4696
5034
  export interface $200 {
4697
5035
  results?: Components.Schemas.PublicLink[];
4698
5036
  }
5037
+ export type $403 = /**
5038
+ * A generic error returned by the API
5039
+ * example:
5040
+ * {
5041
+ * "status": 403,
5042
+ * "error": "Forbidden: You do not have permission to access this file"
5043
+ * }
5044
+ */
5045
+ Components.Responses.ForbiddenError;
5046
+ export type $404 = /**
5047
+ * A generic error returned by the API
5048
+ * example:
5049
+ * {
5050
+ * "status": 404,
5051
+ * "error": "Not Found: File entity not found"
5052
+ * }
5053
+ */
5054
+ Components.Responses.NotFoundError;
4699
5055
  export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
4700
5056
  }
4701
5057
  }
@@ -4766,6 +5122,7 @@ declare namespace Paths {
4766
5122
  * ef7d985c-2385-44f4-9c71-ae06a52264f8
4767
5123
  */
4768
5124
  Components.Schemas.FileEntityId;
5125
+ export type KeepOriginal = boolean;
4769
5126
  export type OrgId = string;
4770
5127
  export type Version = number;
4771
5128
  export type W = number;
@@ -4777,6 +5134,7 @@ declare namespace Paths {
4777
5134
  version?: Parameters.Version;
4778
5135
  w?: Parameters.W;
4779
5136
  h?: Parameters.H;
5137
+ keep_original?: Parameters.KeepOriginal;
4780
5138
  org_id?: Parameters.OrgId;
4781
5139
  }
4782
5140
  namespace Responses {
@@ -4991,6 +5349,24 @@ declare namespace Paths {
4991
5349
  namespace Responses {
4992
5350
  export interface $204 {
4993
5351
  }
5352
+ export type $403 = /**
5353
+ * A generic error returned by the API
5354
+ * example:
5355
+ * {
5356
+ * "status": 403,
5357
+ * "error": "Forbidden: You do not have permission to access this file"
5358
+ * }
5359
+ */
5360
+ Components.Responses.ForbiddenError;
5361
+ export type $404 = /**
5362
+ * A generic error returned by the API
5363
+ * example:
5364
+ * {
5365
+ * "status": 404,
5366
+ * "error": "Not Found: File entity not found"
5367
+ * }
5368
+ */
5369
+ Components.Responses.NotFoundError;
4994
5370
  export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
4995
5371
  }
4996
5372
  }
@@ -5144,6 +5520,70 @@ declare namespace Paths {
5144
5520
  Components.Responses.InternalServerError;
5145
5521
  }
5146
5522
  }
5523
+ namespace UpdateFileAttributeSuggestionStatus {
5524
+ namespace Parameters {
5525
+ export type Id = /**
5526
+ * example:
5527
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
5528
+ */
5529
+ Components.Schemas.FileEntityId;
5530
+ export type JobId = string;
5531
+ }
5532
+ export interface PathParameters {
5533
+ id: Parameters.Id;
5534
+ job_id: Parameters.JobId;
5535
+ }
5536
+ export type RequestBody = Components.Schemas.UpdateFileAttributeSuggestionStatusRequest;
5537
+ namespace Responses {
5538
+ export type $200 = Components.Schemas.FileAttributeSuggestionJob;
5539
+ export type $400 = /**
5540
+ * A generic error returned by the API
5541
+ * example:
5542
+ * {
5543
+ * "status": 400,
5544
+ * "error": "Bad Request: filename is required"
5545
+ * }
5546
+ */
5547
+ Components.Responses.BadRequestError;
5548
+ export type $401 = /**
5549
+ * A generic error returned by the API
5550
+ * example:
5551
+ * {
5552
+ * "status": 401,
5553
+ * "error": "Unauthorized: Invalid or expired token"
5554
+ * }
5555
+ */
5556
+ Components.Responses.UnauthorizedError;
5557
+ export type $403 = /**
5558
+ * A generic error returned by the API
5559
+ * example:
5560
+ * {
5561
+ * "status": 403,
5562
+ * "error": "Forbidden: You do not have permission to access this file"
5563
+ * }
5564
+ */
5565
+ Components.Responses.ForbiddenError;
5566
+ export type $404 = Components.Responses.FileAttributeSuggestionErrorResponse;
5567
+ export type $409 = /**
5568
+ * A generic error returned by the API
5569
+ * example:
5570
+ * {
5571
+ * "status": 409,
5572
+ * "error": "Extracted file content is still being prepared"
5573
+ * }
5574
+ */
5575
+ Components.Responses.ConflictError;
5576
+ export type $500 = /**
5577
+ * A generic error returned by the API
5578
+ * example:
5579
+ * {
5580
+ * "status": 500,
5581
+ * "error": "Internal Server Error"
5582
+ * }
5583
+ */
5584
+ Components.Responses.InternalServerError;
5585
+ }
5586
+ }
5147
5587
  namespace UpdateUserSchemaFileCollection {
5148
5588
  namespace Parameters {
5149
5589
  export type CollectionSlug = string;
@@ -5615,6 +6055,11 @@ interface OperationMethods {
5615
6055
  * 3. Upload the ZIP to temporary storage
5616
6056
  * 4. Send an email notification with the download link
5617
6057
  *
6058
+ * Permissions: requires `entity:download` on files. With `file_entity_ids` every file must be
6059
+ * viewable by the caller, otherwise the request is rejected with 403. An `entity_query` is
6060
+ * resolved with the caller's permissions when the job is created (restricted to `_schema:file`);
6061
+ * only the files it returns are zipped. A query that matches no viewable files returns 400.
6062
+ *
5618
6063
  * The ZIP file will be available for 7 days.
5619
6064
  *
5620
6065
  */
@@ -5703,6 +6148,46 @@ interface OperationMethods {
5703
6148
  data?: any,
5704
6149
  config?: AxiosRequestConfig
5705
6150
  ): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
6151
+ /**
6152
+ * createFileAttributeSuggestionJob - createFileAttributeSuggestionJob
6153
+ *
6154
+ * Start an auto-fill job that reads the file's extracted text and suggests values for the related entity's attributes. Requires `entity:view` on the file and on the related entity. Returns 404 with `error_code: file_not_extracted` while the file has not been extracted yet; callers retry until the extraction is ready.
6155
+ */
6156
+ 'createFileAttributeSuggestionJob'(
6157
+ parameters?: Parameters<Paths.CreateFileAttributeSuggestionJob.PathParameters> | null,
6158
+ data?: Paths.CreateFileAttributeSuggestionJob.RequestBody,
6159
+ config?: AxiosRequestConfig
6160
+ ): OperationResponse<Paths.CreateFileAttributeSuggestionJob.Responses.$202>
6161
+ /**
6162
+ * getLatestFileAttributeSuggestions - getLatestFileAttributeSuggestions
6163
+ *
6164
+ * Get the most recent attribute suggestion job of any status for the file and the given entity. Returns 404 with `error_code: no_file_attribute_suggestions_job` when auto-fill has not run yet.
6165
+ */
6166
+ 'getLatestFileAttributeSuggestions'(
6167
+ parameters?: Parameters<Paths.GetLatestFileAttributeSuggestions.QueryParameters & Paths.GetLatestFileAttributeSuggestions.PathParameters> | null,
6168
+ data?: any,
6169
+ config?: AxiosRequestConfig
6170
+ ): OperationResponse<Paths.GetLatestFileAttributeSuggestions.Responses.$200>
6171
+ /**
6172
+ * getFileAttributeSuggestionJob - getFileAttributeSuggestionJob
6173
+ *
6174
+ * Get an attribute suggestion job of the file. Poll until `jobStatus.status` is `COMPLETED` or `FAILED`.
6175
+ */
6176
+ 'getFileAttributeSuggestionJob'(
6177
+ parameters?: Parameters<Paths.GetFileAttributeSuggestionJob.PathParameters> | null,
6178
+ data?: any,
6179
+ config?: AxiosRequestConfig
6180
+ ): OperationResponse<Paths.GetFileAttributeSuggestionJob.Responses.$200>
6181
+ /**
6182
+ * updateFileAttributeSuggestionStatus - updateFileAttributeSuggestionStatus
6183
+ *
6184
+ * Record that suggestions were accepted, discarded or copied. Only the suggestion entries named in the request change; unknown attribute names are ignored. Applying a value to the entity stays with the caller.
6185
+ */
6186
+ 'updateFileAttributeSuggestionStatus'(
6187
+ parameters?: Parameters<Paths.UpdateFileAttributeSuggestionStatus.PathParameters> | null,
6188
+ data?: Paths.UpdateFileAttributeSuggestionStatus.RequestBody,
6189
+ config?: AxiosRequestConfig
6190
+ ): OperationResponse<Paths.UpdateFileAttributeSuggestionStatus.Responses.$200>
5706
6191
  /**
5707
6192
  * getFileText - getFileText
5708
6193
  *
@@ -5785,6 +6270,11 @@ interface OperationMethods {
5785
6270
  *
5786
6271
  * **No authentication required.** This endpoint only works for files with `access_control: public-read`.
5787
6272
  *
6273
+ * SVG files are rasterized to PNG by default. With `keep_original=true`, SVG files redirect
6274
+ * to the selected version's original S3 object, preserving vector rendering. Width and
6275
+ * height parameters are ignored only for SVG files when this option is enabled.
6276
+ * This option only applies to SVG files; previews of other file formats are unchanged.
6277
+ *
5788
6278
  */
5789
6279
  'previewPublicFile'(
5790
6280
  parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
@@ -6175,6 +6665,11 @@ interface PathsDictionary {
6175
6665
  * 3. Upload the ZIP to temporary storage
6176
6666
  * 4. Send an email notification with the download link
6177
6667
  *
6668
+ * Permissions: requires `entity:download` on files. With `file_entity_ids` every file must be
6669
+ * viewable by the caller, otherwise the request is rejected with 403. An `entity_query` is
6670
+ * resolved with the caller's permissions when the job is created (restricted to `_schema:file`);
6671
+ * only the files it returns are zipped. A query that matches no viewable files returns 400.
6672
+ *
6178
6673
  * The ZIP file will be available for 7 days.
6179
6674
  *
6180
6675
  */
@@ -6278,6 +6773,52 @@ interface PathsDictionary {
6278
6773
  config?: AxiosRequestConfig
6279
6774
  ): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
6280
6775
  }
6776
+ ['/v1/files/{id}/attribute-suggestion-jobs']: {
6777
+ /**
6778
+ * createFileAttributeSuggestionJob - createFileAttributeSuggestionJob
6779
+ *
6780
+ * Start an auto-fill job that reads the file's extracted text and suggests values for the related entity's attributes. Requires `entity:view` on the file and on the related entity. Returns 404 with `error_code: file_not_extracted` while the file has not been extracted yet; callers retry until the extraction is ready.
6781
+ */
6782
+ 'post'(
6783
+ parameters?: Parameters<Paths.CreateFileAttributeSuggestionJob.PathParameters> | null,
6784
+ data?: Paths.CreateFileAttributeSuggestionJob.RequestBody,
6785
+ config?: AxiosRequestConfig
6786
+ ): OperationResponse<Paths.CreateFileAttributeSuggestionJob.Responses.$202>
6787
+ }
6788
+ ['/v1/files/{id}/attribute-suggestion-jobs/latest']: {
6789
+ /**
6790
+ * getLatestFileAttributeSuggestions - getLatestFileAttributeSuggestions
6791
+ *
6792
+ * Get the most recent attribute suggestion job of any status for the file and the given entity. Returns 404 with `error_code: no_file_attribute_suggestions_job` when auto-fill has not run yet.
6793
+ */
6794
+ 'get'(
6795
+ parameters?: Parameters<Paths.GetLatestFileAttributeSuggestions.QueryParameters & Paths.GetLatestFileAttributeSuggestions.PathParameters> | null,
6796
+ data?: any,
6797
+ config?: AxiosRequestConfig
6798
+ ): OperationResponse<Paths.GetLatestFileAttributeSuggestions.Responses.$200>
6799
+ }
6800
+ ['/v1/files/{id}/attribute-suggestion-jobs/{job_id}']: {
6801
+ /**
6802
+ * getFileAttributeSuggestionJob - getFileAttributeSuggestionJob
6803
+ *
6804
+ * Get an attribute suggestion job of the file. Poll until `jobStatus.status` is `COMPLETED` or `FAILED`.
6805
+ */
6806
+ 'get'(
6807
+ parameters?: Parameters<Paths.GetFileAttributeSuggestionJob.PathParameters> | null,
6808
+ data?: any,
6809
+ config?: AxiosRequestConfig
6810
+ ): OperationResponse<Paths.GetFileAttributeSuggestionJob.Responses.$200>
6811
+ /**
6812
+ * updateFileAttributeSuggestionStatus - updateFileAttributeSuggestionStatus
6813
+ *
6814
+ * Record that suggestions were accepted, discarded or copied. Only the suggestion entries named in the request change; unknown attribute names are ignored. Applying a value to the entity stays with the caller.
6815
+ */
6816
+ 'patch'(
6817
+ parameters?: Parameters<Paths.UpdateFileAttributeSuggestionStatus.PathParameters> | null,
6818
+ data?: Paths.UpdateFileAttributeSuggestionStatus.RequestBody,
6819
+ config?: AxiosRequestConfig
6820
+ ): OperationResponse<Paths.UpdateFileAttributeSuggestionStatus.Responses.$200>
6821
+ }
6281
6822
  ['/v1/files/{id}/text']: {
6282
6823
  /**
6283
6824
  * getFileText - getFileText
@@ -6369,6 +6910,11 @@ interface PathsDictionary {
6369
6910
  *
6370
6911
  * **No authentication required.** This endpoint only works for files with `access_control: public-read`.
6371
6912
  *
6913
+ * SVG files are rasterized to PNG by default. With `keep_original=true`, SVG files redirect
6914
+ * to the selected version's original S3 object, preserving vector rendering. Width and
6915
+ * height parameters are ignored only for SVG files when this option is enabled.
6916
+ * This option only applies to SVG files; previews of other file formats are unchanged.
6917
+ *
6372
6918
  */
6373
6919
  'get'(
6374
6920
  parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
@@ -6608,6 +7154,7 @@ type BaseEntityAcl = Components.Schemas.BaseEntityAcl;
6608
7154
  type BaseEntityOwner = Components.Schemas.BaseEntityOwner;
6609
7155
  type BatchSaveFileVersionPayload = Components.Schemas.BatchSaveFileVersionPayload;
6610
7156
  type CommonSaveFilePayload = Components.Schemas.CommonSaveFilePayload;
7157
+ type CreateFileAttributeSuggestionJobRequest = Components.Schemas.CreateFileAttributeSuggestionJobRequest;
6611
7158
  type CreateZipJobPayload = Components.Schemas.CreateZipJobPayload;
6612
7159
  type CustomDownloadUrl = Components.Schemas.CustomDownloadUrl;
6613
7160
  type CustomDownloadUrlAuth = Components.Schemas.CustomDownloadUrlAuth;
@@ -6615,6 +7162,11 @@ type DownloadFilesPayload = Components.Schemas.DownloadFilesPayload;
6615
7162
  type EntityId = Components.Schemas.EntityId;
6616
7163
  type EntitySlug = Components.Schemas.EntitySlug;
6617
7164
  type ErrorObject = Components.Schemas.ErrorObject;
7165
+ type FileAttributeSuggestion = Components.Schemas.FileAttributeSuggestion;
7166
+ type FileAttributeSuggestionError = Components.Schemas.FileAttributeSuggestionError;
7167
+ type FileAttributeSuggestionJob = Components.Schemas.FileAttributeSuggestionJob;
7168
+ type FileAttributeSuggestionJobStatus = Components.Schemas.FileAttributeSuggestionJobStatus;
7169
+ type FileAttributeSuggestionsPayload = Components.Schemas.FileAttributeSuggestionsPayload;
6618
7170
  type FileAttributes = Components.Schemas.FileAttributes;
6619
7171
  type FileCollectionAttributes = Components.Schemas.FileCollectionAttributes;
6620
7172
  type FileCollectionCreateRequest = Components.Schemas.FileCollectionCreateRequest;
@@ -6654,8 +7206,9 @@ type SaveFileFromSourceURLPayload = Components.Schemas.SaveFileFromSourceURLPayl
6654
7206
  type SaveFilePayload = Components.Schemas.SaveFilePayload;
6655
7207
  type SaveFilePayloadV2 = Components.Schemas.SaveFilePayloadV2;
6656
7208
  type SaveS3FilePayload = Components.Schemas.SaveS3FilePayload;
7209
+ type UpdateFileAttributeSuggestionStatusRequest = Components.Schemas.UpdateFileAttributeSuggestionStatusRequest;
6657
7210
  type UploadFilePayload = Components.Schemas.UploadFilePayload;
6658
7211
  type VerifyCustomDownloadUrlPayload = Components.Schemas.VerifyCustomDownloadUrlPayload;
6659
7212
  type ZipJob = Components.Schemas.ZipJob;
6660
7213
 
6661
- export { type SaveFilePayload as $, type ActivityId as A, type BaseEntityAcl as B, type Client as C, type DownloadFilesPayload as D, type EntityId as E, type FileAttributes as F, type FileTextStatus as G, type FileTextUnsupported as H, type FileType as I, type FileUpload as J, type FileValidation as K, type FileValidationConditionResult as L, type FileValidationFacts as M, type FileValidationFile as N, type OperationMethods as O, Paths as P, type FileValidationFileReference as Q, type FileValidationJudgement as R, type FileValidationObservation as S, type FileValidationRequest as T, type FileValidationRuleResult as U, type PublicLink as V, type PutFileSummaryFeedbackRequest as W, type S3Ref as X, type S3Reference as Y, type SaveCustomFilePayload as Z, type SaveFileFromSourceURLPayload as _, Components as a, type SaveFilePayloadV2 as a0, type SaveS3FilePayload as a1, type UploadFilePayload as a2, type VerifyCustomDownloadUrlPayload as a3, type ZipJob as a4, type PathsDictionary as b, type BaseEntityOwner as c, type BatchSaveFileVersionPayload as d, type CommonSaveFilePayload as e, type CreateZipJobPayload as f, type CustomDownloadUrl as g, type CustomDownloadUrlAuth as h, type EntitySlug as i, type ErrorObject as j, type FileCollectionAttributes as k, type FileCollectionCreateRequest as l, type FileCollectionId as m, type FileCollectionItem as n, type FileEntity as o, type FileEntityId as p, type FileItem as q, type FileRelationItem as r, type FileSummary as s, type FileSummaryFeedback as t, type FileSummaryFeedbackResponse as u, type FileSummaryJob as v, type FileSummaryJobStatus as w, type FileText as x, type FileTextNotReady as y, type FileTextReady as z };
7214
+ export { type PublicLink as $, type ActivityId as A, type BaseEntityAcl as B, type Client as C, type DownloadFilesPayload as D, type EntityId as E, type FileAttributeSuggestion as F, type FileSummaryFeedbackResponse as G, type FileSummaryJob as H, type FileSummaryJobStatus as I, type FileText as J, type FileTextNotReady as K, type FileTextReady as L, type FileTextStatus as M, type FileTextUnsupported as N, type OperationMethods as O, Paths as P, type FileType as Q, type FileUpload as R, type FileValidation as S, type FileValidationConditionResult as T, type FileValidationFacts as U, type FileValidationFile as V, type FileValidationFileReference as W, type FileValidationJudgement as X, type FileValidationObservation as Y, type FileValidationRequest as Z, type FileValidationRuleResult as _, Components as a, type PutFileSummaryFeedbackRequest as a0, type S3Ref as a1, type S3Reference as a2, type SaveCustomFilePayload as a3, type SaveFileFromSourceURLPayload as a4, type SaveFilePayload as a5, type SaveFilePayloadV2 as a6, type SaveS3FilePayload as a7, type UpdateFileAttributeSuggestionStatusRequest as a8, type UploadFilePayload as a9, type VerifyCustomDownloadUrlPayload as aa, type ZipJob as ab, type PathsDictionary as b, type BaseEntityOwner as c, type BatchSaveFileVersionPayload as d, type CommonSaveFilePayload as e, type CreateFileAttributeSuggestionJobRequest as f, type CreateZipJobPayload as g, type CustomDownloadUrl as h, type CustomDownloadUrlAuth as i, type EntitySlug as j, type ErrorObject as k, type FileAttributeSuggestionError as l, type FileAttributeSuggestionJob as m, type FileAttributeSuggestionJobStatus as n, type FileAttributeSuggestionsPayload as o, type FileAttributes as p, type FileCollectionAttributes as q, type FileCollectionCreateRequest as r, type FileCollectionId as s, type FileCollectionItem as t, type FileEntity as u, type FileEntityId as v, type FileItem as w, type FileRelationItem as x, type FileSummary as y, type FileSummaryFeedback as z };