@epilot/sdk 2.20.72 → 2.20.74

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 (141) hide show
  1. package/definitions/entity-runtime.json +1 -1
  2. package/definitions/entity.json +1491 -44
  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 +8 -8
  48. package/dist/apis/entity.d.cts +2 -2
  49. package/dist/apis/entity.d.ts +2 -2
  50. package/dist/apis/entity.js +2 -2
  51. package/dist/apis/environments.cjs +6 -6
  52. package/dist/apis/environments.js +1 -1
  53. package/dist/apis/event-catalog.cjs +6 -6
  54. package/dist/apis/event-catalog.js +1 -1
  55. package/dist/apis/external-values.cjs +6 -6
  56. package/dist/apis/external-values.js +1 -1
  57. package/dist/apis/file.cjs +6 -6
  58. package/dist/apis/file.js +1 -1
  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.d.cts +2 -2
  63. package/dist/apis/identity.d.ts +2 -2
  64. package/dist/apis/identity.js +1 -1
  65. package/dist/apis/integration-toolkit.cjs +6 -6
  66. package/dist/apis/integration-toolkit.js +1 -1
  67. package/dist/apis/journey.cjs +6 -6
  68. package/dist/apis/journey.js +1 -1
  69. package/dist/apis/kanban.cjs +6 -6
  70. package/dist/apis/kanban.js +1 -1
  71. package/dist/apis/message.cjs +6 -6
  72. package/dist/apis/message.js +1 -1
  73. package/dist/apis/metering.cjs +6 -6
  74. package/dist/apis/metering.js +1 -1
  75. package/dist/apis/notes.cjs +6 -6
  76. package/dist/apis/notes.js +1 -1
  77. package/dist/apis/notification.cjs +6 -6
  78. package/dist/apis/notification.js +1 -1
  79. package/dist/apis/organization.cjs +6 -6
  80. package/dist/apis/organization.js +1 -1
  81. package/dist/apis/partner-directory.cjs +6 -6
  82. package/dist/apis/partner-directory.js +1 -1
  83. package/dist/apis/permissions.cjs +6 -6
  84. package/dist/apis/permissions.js +1 -1
  85. package/dist/apis/phone-integration.cjs +6 -6
  86. package/dist/apis/phone-integration.js +1 -1
  87. package/dist/apis/pricing-tier.cjs +6 -6
  88. package/dist/apis/pricing-tier.js +1 -1
  89. package/dist/apis/pricing.cjs +6 -6
  90. package/dist/apis/pricing.js +1 -1
  91. package/dist/apis/purpose.cjs +6 -6
  92. package/dist/apis/purpose.js +1 -1
  93. package/dist/apis/query.cjs +6 -6
  94. package/dist/apis/query.js +1 -1
  95. package/dist/apis/sandbox.cjs +6 -6
  96. package/dist/apis/sandbox.js +1 -1
  97. package/dist/apis/sharing.cjs +6 -6
  98. package/dist/apis/sharing.js +1 -1
  99. package/dist/apis/snapshot.cjs +6 -6
  100. package/dist/apis/snapshot.js +1 -1
  101. package/dist/apis/submission.cjs +6 -6
  102. package/dist/apis/submission.js +1 -1
  103. package/dist/apis/target.cjs +6 -6
  104. package/dist/apis/target.js +1 -1
  105. package/dist/apis/targeting.cjs +6 -6
  106. package/dist/apis/targeting.js +1 -1
  107. package/dist/apis/template-variables.cjs +6 -6
  108. package/dist/apis/template-variables.js +1 -1
  109. package/dist/apis/user.cjs +6 -6
  110. package/dist/apis/user.js +1 -1
  111. package/dist/apis/validation-rules.cjs +6 -6
  112. package/dist/apis/validation-rules.js +1 -1
  113. package/dist/apis/webhooks.cjs +6 -6
  114. package/dist/apis/webhooks.js +1 -1
  115. package/dist/apis/workflow-definition.cjs +6 -6
  116. package/dist/apis/workflow-definition.js +1 -1
  117. package/dist/apis/workflow.cjs +6 -6
  118. package/dist/apis/workflow.js +1 -1
  119. package/dist/chunk-3JBENXET.cjs +14 -0
  120. package/dist/{chunk-5QSR7CYT.cjs → chunk-5PG5IEQ7.cjs} +2 -2
  121. package/dist/chunk-K77ESMSG.js +14 -0
  122. package/dist/{chunk-B42G3PU6.js → chunk-WG7OKIQ3.js} +2 -2
  123. package/dist/entity-GZC53ATN.cjs +7 -0
  124. package/dist/entity-T26ZCCI6.js +7 -0
  125. package/dist/entity-runtime-L3EGYXRI.cjs +5 -0
  126. package/dist/{entity-runtime-JRSXJKRV.js → entity-runtime-YZPCXKZW.js} +1 -1
  127. package/dist/{entity.d-BwsBk0Po.d.cts → entity.d-DlI8zhXF.d.cts} +1369 -75
  128. package/dist/{entity.d-BwsBk0Po.d.ts → entity.d-DlI8zhXF.d.ts} +1369 -75
  129. package/dist/{identity.d-BBL0NI_O.d.cts → identity.d-CieYn1WL.d.cts} +143 -17
  130. package/dist/{identity.d-BBL0NI_O.d.ts → identity.d-CieYn1WL.d.ts} +143 -17
  131. package/dist/index.cjs +10 -10
  132. package/dist/index.d.cts +2 -2
  133. package/dist/index.d.ts +2 -2
  134. package/dist/index.js +2 -2
  135. package/docs/entity.md +586 -3
  136. package/package.json +1 -1
  137. package/dist/chunk-KXNPNC4J.js +0 -14
  138. package/dist/chunk-XT2XPHUH.cjs +0 -14
  139. package/dist/entity-AQTIV5LR.js +0 -7
  140. package/dist/entity-TJAYHTIU.cjs +0 -7
  141. package/dist/entity-runtime-DYQQGB4F.cjs +0 -5
@@ -3779,6 +3779,37 @@ declare namespace Components {
3779
3779
  * contact
3780
3780
  */
3781
3781
  schema: string;
3782
+ /**
3783
+ * Attribute names (text, email or number) used to match rows to existing entities, combined with AND.
3784
+ * Use `["_id"]` to match by entity id only. Empty by default, which keeps the current behaviour.
3785
+ *
3786
+ * example:
3787
+ * [
3788
+ * "email"
3789
+ * ]
3790
+ */
3791
+ unique_key?: [
3792
+ string?,
3793
+ string?,
3794
+ string?,
3795
+ string?,
3796
+ string?
3797
+ ];
3798
+ /**
3799
+ * Report the outcome of every row without writing any entities.
3800
+ */
3801
+ dry_run?: boolean;
3802
+ /**
3803
+ * The job id of a completed dry run that this import commits. Cannot be combined with `dry_run`.
3804
+ */
3805
+ dry_run_job_id?: string;
3806
+ /**
3807
+ * Write committed rows as normal creates and updates: they emit entity events, so automations
3808
+ * run, and each entity gets its activities. Off by default, when imported rows trigger no
3809
+ * automations. Cannot be combined with `dry_run: true`.
3810
+ *
3811
+ */
3812
+ trigger_automations?: boolean;
3782
3813
  }
3783
3814
  /**
3784
3815
  * example:
@@ -4600,6 +4631,12 @@ declare namespace Components {
4600
4631
  * false
4601
4632
  */
4602
4633
  draft?: boolean;
4634
+ /**
4635
+ * When true, the entity builder requires a change comment before saving a new version of this schema. Absent is treated as false. Enforced by the builder UI only; the API does not reject schema writes without a comment.
4636
+ * example:
4637
+ * false
4638
+ */
4639
+ require_change_comment?: boolean;
4603
4640
  /**
4604
4641
  * example:
4605
4642
  * person
@@ -5132,6 +5169,12 @@ declare namespace Components {
5132
5169
  * false
5133
5170
  */
5134
5171
  draft?: boolean;
5172
+ /**
5173
+ * When true, the entity builder requires a change comment before saving a new version of this schema. Absent is treated as false. Enforced by the builder UI only; the API does not reject schema writes without a comment.
5174
+ * example:
5175
+ * false
5176
+ */
5177
+ require_change_comment?: boolean;
5135
5178
  /**
5136
5179
  * example:
5137
5180
  * person
@@ -5764,6 +5807,23 @@ declare namespace Components {
5764
5807
  * contact
5765
5808
  */
5766
5809
  export type EntitySlug = string; // ^[a-zA-Z0-9_-]+$
5810
+ /**
5811
+ * Latest AI generated summary of an entity
5812
+ */
5813
+ export interface EntitySummary {
5814
+ /**
5815
+ * Markdown summary
5816
+ */
5817
+ summary: string;
5818
+ variant: "short" | "detailed" | "action_points";
5819
+ /**
5820
+ * ai-agents-api execution that generated the summary. Feedback is keyed by it.
5821
+ * example:
5822
+ * 7b4cfc0f-1d5e-4f3a-9b4a-2c7d1f9e8a10
5823
+ */
5824
+ execution_id: string;
5825
+ created_at: string; // date-time
5826
+ }
5767
5827
  export interface EntityTableFilterOption {
5768
5828
  /**
5769
5829
  * The type of filter option
@@ -6895,6 +6955,213 @@ declare namespace Components {
6895
6955
  entity_id: EntityId /* uuid */;
6896
6956
  }[];
6897
6957
  }
6958
+ /**
6959
+ * Machine readable reason of a failed job. `failure_reason` holds the human text.
6960
+ * - `invalid_csv_bad_headers`: the file has neither a `_schema` nor an `_id` column
6961
+ * - `dry_run_required`, `dry_run_mismatch`, `dry_run_expired`: the dry-run rule rejected the commit before any row
6962
+ * - `import_file_changed`: the file was replaced after the pre-scan
6963
+ * - `prescan_missing`: the job cannot be continued after an update
6964
+ * - `import_too_large`: the file has more rows than a single job can report on
6965
+ * - `token_expired`: the session that started the job expired before it finished
6966
+ * - `max_duration_exceeded`: the job ran longer than allowed
6967
+ * - `no_progress`: consecutive runs made no progress
6968
+ * - `internal_error`: an unexpected error ended the job
6969
+ *
6970
+ */
6971
+ export type ImportFailureCode = "invalid_csv_bad_headers" | "dry_run_required" | "dry_run_mismatch" | "dry_run_expired" | "import_file_changed" | "prescan_missing" | "import_too_large" | "token_expired" | "max_duration_exceeded" | "no_progress" | "internal_error";
6972
+ /**
6973
+ * Rows of an import job that share one reason not to be written.
6974
+ */
6975
+ export interface ImportIssue {
6976
+ /**
6977
+ * `blocking` for rows with the outcome `error`, `warning` for the `skipped_*` outcomes.
6978
+ *
6979
+ */
6980
+ severity: "blocking" | "warning";
6981
+ /**
6982
+ * Blocking: the row reason's text before its first `: `, one issue per `; `-separated part, e.g.
6983
+ * `Invalid date for birthdate` or `Unknown purpose id`. Warning: the outcome, e.g. `skipped_duplicate_in_file`.
6984
+ *
6985
+ */
6986
+ reason: string;
6987
+ /**
6988
+ * The column the reason names (`… for <column>` or `… in <column>`), if any.
6989
+ */
6990
+ column?: string;
6991
+ /**
6992
+ * Number of rows with this issue.
6993
+ */
6994
+ count: number;
6995
+ /**
6996
+ * The first (at most 5) row numbers with this issue, 1-based data rows as in the report.
6997
+ */
6998
+ example_rows: number[];
6999
+ }
7000
+ /**
7001
+ * One import job (import or dry run) in the import history of a schema.
7002
+ */
7003
+ export interface ImportJobSummary {
7004
+ /**
7005
+ * The ID of the import job, as returned in `jobPollId`. Poll it to resume the job.
7006
+ */
7007
+ job_id: string;
7008
+ schema: string;
7009
+ status: "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED";
7010
+ dry_run: boolean;
7011
+ trigger_automations?: boolean;
7012
+ /**
7013
+ * User id of whoever started the job.
7014
+ */
7015
+ started_by?: string;
7016
+ started_at: string; // date-time
7017
+ finished_at?: string; // date-time
7018
+ /**
7019
+ * Name of the imported file, for display.
7020
+ */
7021
+ file_name?: string;
7022
+ total?: number;
7023
+ importedEntitiesCount?: number;
7024
+ failedEntitiesCount?: number;
7025
+ outcome_counts?: /* Number of rows per outcome, in the order the outcomes are evaluated. */ ImportRowOutcomeCounts;
7026
+ failure_code?: /**
7027
+ * Machine readable reason of a failed job. `failure_reason` holds the human text.
7028
+ * - `invalid_csv_bad_headers`: the file has neither a `_schema` nor an `_id` column
7029
+ * - `dry_run_required`, `dry_run_mismatch`, `dry_run_expired`: the dry-run rule rejected the commit before any row
7030
+ * - `import_file_changed`: the file was replaced after the pre-scan
7031
+ * - `prescan_missing`: the job cannot be continued after an update
7032
+ * - `import_too_large`: the file has more rows than a single job can report on
7033
+ * - `token_expired`: the session that started the job expired before it finished
7034
+ * - `max_duration_exceeded`: the job ran longer than allowed
7035
+ * - `no_progress`: consecutive runs made no progress
7036
+ * - `internal_error`: an unexpected error ended the job
7037
+ *
7038
+ */
7039
+ ImportFailureCode;
7040
+ unique_key?: string[];
7041
+ }
7042
+ /**
7043
+ * Progress of an import job. The fields `dry_run`, `unique_key`, `outcome_counts`, `report_url`,
7044
+ * `S3Reference` and `started_by` are only set for jobs started with `unique_key`, `dry_run` or `dry_run_job_id`. For those,
7045
+ * `importedEntitiesCount` is `create` plus `update` and `failedEntitiesCount` counts `error` rows only.
7046
+ *
7047
+ */
7048
+ export interface ImportProgress {
7049
+ /**
7050
+ * The ID of the import job.
7051
+ */
7052
+ jobPollId?: string;
7053
+ /**
7054
+ * Whether committed rows of the job trigger automations.
7055
+ */
7056
+ trigger_automations?: boolean;
7057
+ /**
7058
+ * User id of whoever started the job. A finished job is only returned by `entity:import:latest`
7059
+ * to this user, and only this user can commit or discard a dry run.
7060
+ *
7061
+ */
7062
+ started_by?: string;
7063
+ status?: "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED";
7064
+ /**
7065
+ * Number of data rows in the file, once known.
7066
+ */
7067
+ total?: number;
7068
+ importedEntitiesCount?: number;
7069
+ failedEntitiesCount?: number;
7070
+ importedEntitiesUrl?: string;
7071
+ failedEntitiesUrl?: string;
7072
+ updated_at?: string; // date-time
7073
+ failure_reason?: string;
7074
+ failure_code?: /**
7075
+ * Machine readable reason of a failed job. `failure_reason` holds the human text.
7076
+ * - `invalid_csv_bad_headers`: the file has neither a `_schema` nor an `_id` column
7077
+ * - `dry_run_required`, `dry_run_mismatch`, `dry_run_expired`: the dry-run rule rejected the commit before any row
7078
+ * - `import_file_changed`: the file was replaced after the pre-scan
7079
+ * - `prescan_missing`: the job cannot be continued after an update
7080
+ * - `import_too_large`: the file has more rows than a single job can report on
7081
+ * - `token_expired`: the session that started the job expired before it finished
7082
+ * - `max_duration_exceeded`: the job ran longer than allowed
7083
+ * - `no_progress`: consecutive runs made no progress
7084
+ * - `internal_error`: an unexpected error ended the job
7085
+ *
7086
+ */
7087
+ ImportFailureCode;
7088
+ abortable?: boolean;
7089
+ dry_run?: boolean;
7090
+ unique_key?: string[];
7091
+ outcome_counts?: /* Number of rows per outcome, in the order the outcomes are evaluated. */ ImportRowOutcomeCounts;
7092
+ /**
7093
+ * Download link of the per-row report (CSV, UTF-8 with BOM).
7094
+ */
7095
+ report_url?: string;
7096
+ /**
7097
+ * The imported file. Send it back with `dry_run_job_id` to commit a dry run.
7098
+ */
7099
+ S3Reference?: {
7100
+ bucket?: string;
7101
+ key?: string;
7102
+ };
7103
+ /**
7104
+ * The rows that are not written, grouped by why: blocking issues first, then by count, at most 20.
7105
+ * The warnings always get a place. Blocking issues beyond the 50 tracked are counted as `Other errors`.
7106
+ * Only for jobs started with `unique_key`, `dry_run` or `dry_run_job_id`.
7107
+ *
7108
+ */
7109
+ issues?: [
7110
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7111
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7112
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7113
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7114
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7115
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7116
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7117
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7118
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7119
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7120
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7121
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7122
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7123
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7124
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7125
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7126
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7127
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7128
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?,
7129
+ /* Rows of an import job that share one reason not to be written. */ ImportIssue?
7130
+ ];
7131
+ /**
7132
+ * What the job is doing now: `scanning` the file (pre-scan), running the `dry_run` or `importing`
7133
+ * rows, `finalizing` the report, or `done` (every terminal status).
7134
+ *
7135
+ */
7136
+ phase?: "scanning" | "dry_run" | "importing" | "finalizing" | "done";
7137
+ /**
7138
+ * Refreshed at every phase change and at least every few seconds while the job makes progress
7139
+ * (rows or pre-scan). A PROCESSING job whose heartbeat is minutes old may be stuck.
7140
+ *
7141
+ */
7142
+ heartbeat_at?: string; // date-time
7143
+ /**
7144
+ * When the job started.
7145
+ */
7146
+ started_at?: string; // date-time
7147
+ /**
7148
+ * When the job ended; set on a terminal status.
7149
+ */
7150
+ finished_at?: string; // date-time
7151
+ }
7152
+ /**
7153
+ * Number of rows per outcome, in the order the outcomes are evaluated.
7154
+ */
7155
+ export interface ImportRowOutcomeCounts {
7156
+ error?: number;
7157
+ skipped_empty_key?: number;
7158
+ skipped_duplicate_in_file?: number;
7159
+ skipped_id_not_found?: number;
7160
+ skipped_ambiguous?: number;
7161
+ create?: number;
7162
+ unchanged?: number;
7163
+ update?: number;
7164
+ }
6898
7165
  /**
6899
7166
  * No UI representation
6900
7167
  */
@@ -11506,10 +11773,51 @@ declare namespace Components {
11506
11773
  */
11507
11774
  type: "string" | "number" | "date" | "daterange" | "boolean";
11508
11775
  }
11776
+ export interface SchemaHead {
11777
+ slug: /**
11778
+ * URL-friendly identifier for the entity schema
11779
+ * example:
11780
+ * contact
11781
+ */
11782
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11783
+ id?: string;
11784
+ version: number;
11785
+ updated_at?: string; // date-time
11786
+ /**
11787
+ * Who saved this version
11788
+ */
11789
+ created_by?: string;
11790
+ }
11509
11791
  /**
11510
11792
  * Generated uuid for schema
11511
11793
  */
11512
11794
  export type SchemaId = string; // uuid
11795
+ export interface SchemaVersionConflictError {
11796
+ /**
11797
+ * example:
11798
+ * 409
11799
+ */
11800
+ status?: number;
11801
+ /**
11802
+ * example:
11803
+ * SchemaVersionConflict
11804
+ */
11805
+ error?: string;
11806
+ message?: string;
11807
+ /**
11808
+ * The version the rejected save was made on top of
11809
+ */
11810
+ base_version?: number;
11811
+ /**
11812
+ * The version saves currently land on top of
11813
+ */
11814
+ current_version?: number;
11815
+ current_updated_at?: string; // date-time
11816
+ /**
11817
+ * Who saved the current version
11818
+ */
11819
+ current_created_by?: string;
11820
+ }
11513
11821
  /**
11514
11822
  * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
11515
11823
  * example:
@@ -13628,6 +13936,61 @@ declare namespace Components {
13628
13936
  type: "relation_user";
13629
13937
  multiple?: boolean;
13630
13938
  }
13939
+ /**
13940
+ * A request to wipe entity data of an organization, and its progress
13941
+ */
13942
+ export interface WipeJob {
13943
+ id: string;
13944
+ /**
13945
+ * The schemas being wiped. null means all schemas.
13946
+ */
13947
+ schemas: /**
13948
+ * URL-friendly identifier for the entity schema
13949
+ * example:
13950
+ * contact
13951
+ */
13952
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */[] | null;
13953
+ status: "running" | "succeeded" | "failed";
13954
+ current_step: "SANITY_CHECK" | "DELETE_ELASTIC_INDICES" | "DELETE_DYNAMODB_ENTITIES" | "DELETE_DYNAMODB_RELATIONS" | "DELETE_DYNAMODB_ACTIVITIES" | "DELETE_CLICKHOUSE_ENTITIES" | "DELETE_CLICKHOUSE_ENTITY_OPERATIONS" | "DELETE_S3_FILES" | "SUCCESS" | "FAIL";
13955
+ created_at: string; // date-time
13956
+ updated_at: string; // date-time
13957
+ finished_at?: string; // date-time
13958
+ created_by?: {
13959
+ user_id?: string;
13960
+ email?: string;
13961
+ display_name?: string;
13962
+ };
13963
+ /**
13964
+ * Number of entities per schema at the time the wipe was requested
13965
+ */
13966
+ entity_totals: {
13967
+ [name: string]: number;
13968
+ };
13969
+ /**
13970
+ * Sum of entity_totals
13971
+ */
13972
+ total_entities: number;
13973
+ progress: {
13974
+ indices_deleted?: number;
13975
+ entities_deleted?: number;
13976
+ relations_deleted?: number;
13977
+ activities_deleted?: number;
13978
+ };
13979
+ error?: string;
13980
+ }
13981
+ export interface WipeJobConflictError {
13982
+ /**
13983
+ * example:
13984
+ * 409
13985
+ */
13986
+ status?: number;
13987
+ error?: string;
13988
+ message: string;
13989
+ /**
13990
+ * Requested schemas that are already being wiped
13991
+ */
13992
+ conflicting_schemas: string[];
13993
+ }
13631
13994
  }
13632
13995
  }
13633
13996
  declare namespace Paths {
@@ -14566,6 +14929,47 @@ declare namespace Paths {
14566
14929
  Components.Responses.TooManyRequestsError;
14567
14930
  }
14568
14931
  }
14932
+ namespace DiscardEntityImport {
14933
+ namespace Parameters {
14934
+ export type JobId = /**
14935
+ * The unique identifier of the import job.
14936
+ * example:
14937
+ * abc123
14938
+ */
14939
+ Components.Schemas.ExportJobId;
14940
+ export type Schema = string;
14941
+ }
14942
+ export interface QueryParameters {
14943
+ job_id: Parameters.JobId;
14944
+ schema: Parameters.Schema;
14945
+ }
14946
+ namespace Responses {
14947
+ export interface $200 {
14948
+ /**
14949
+ * `CANCELLED`
14950
+ */
14951
+ status?: string;
14952
+ jobPollId?: string;
14953
+ }
14954
+ export interface $400 {
14955
+ }
14956
+ export interface $403 {
14957
+ }
14958
+ export interface $404 {
14959
+ }
14960
+ export interface $409 {
14961
+ }
14962
+ export type $429 = /**
14963
+ * A generic error returned by the API
14964
+ * example:
14965
+ * {
14966
+ * "status": 429,
14967
+ * "error": "Too many requests. Try again later."
14968
+ * }
14969
+ */
14970
+ Components.Responses.TooManyRequestsError;
14971
+ }
14972
+ }
14569
14973
  namespace DismissChangeset {
14570
14974
  namespace Parameters {
14571
14975
  export type Attribute = string;
@@ -14958,6 +15362,61 @@ declare namespace Paths {
14958
15362
  Components.Responses.NotFoundError;
14959
15363
  }
14960
15364
  }
15365
+ namespace GetEntityImportHistory {
15366
+ namespace Parameters {
15367
+ export type Limit = number;
15368
+ export type Schema = string;
15369
+ }
15370
+ export interface QueryParameters {
15371
+ schema: Parameters.Schema;
15372
+ limit?: Parameters.Limit;
15373
+ }
15374
+ namespace Responses {
15375
+ export interface $200 {
15376
+ jobs: /* One import job (import or dry run) in the import history of a schema. */ Components.Schemas.ImportJobSummary[];
15377
+ }
15378
+ export interface $400 {
15379
+ }
15380
+ export interface $403 {
15381
+ }
15382
+ export type $429 = /**
15383
+ * A generic error returned by the API
15384
+ * example:
15385
+ * {
15386
+ * "status": 429,
15387
+ * "error": "Too many requests. Try again later."
15388
+ * }
15389
+ */
15390
+ Components.Responses.TooManyRequestsError;
15391
+ }
15392
+ }
15393
+ namespace GetEntitySummary {
15394
+ namespace Parameters {
15395
+ export type Id = Components.Schemas.EntityId /* uuid */;
15396
+ export type Slug = /**
15397
+ * URL-friendly identifier for the entity schema
15398
+ * example:
15399
+ * contact
15400
+ */
15401
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
15402
+ }
15403
+ export interface PathParameters {
15404
+ slug: Parameters.Slug;
15405
+ id: Parameters.Id;
15406
+ }
15407
+ namespace Responses {
15408
+ export type $200 = /* Latest AI generated summary of an entity */ Components.Schemas.EntitySummary;
15409
+ export type $404 = /**
15410
+ * A generic error returned by the API
15411
+ * example:
15412
+ * {
15413
+ * "status": 404,
15414
+ * "error": "Not Found"
15415
+ * }
15416
+ */
15417
+ Components.Responses.NotFoundError;
15418
+ }
15419
+ }
14961
15420
  namespace GetEntityV2 {
14962
15421
  namespace Parameters {
14963
15422
  export type Anonymize = boolean;
@@ -15378,24 +15837,56 @@ declare namespace Paths {
15378
15837
  }
15379
15838
  }
15380
15839
  }
15381
- namespace GetRelatedEntitiesCount {
15840
+ namespace GetLatestEntityImport {
15382
15841
  namespace Parameters {
15383
- export type ExcludeSchemas = /**
15384
- * URL-friendly identifier for the entity schema
15385
- * example:
15386
- * contact
15387
- */
15388
- Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
15389
- export type Id = Components.Schemas.EntityId /* uuid */;
15390
- export type Slug = /**
15391
- * URL-friendly identifier for the entity schema
15392
- * example:
15393
- * contact
15394
- */
15395
- Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
15842
+ export type Schema = string;
15396
15843
  }
15397
- export interface PathParameters {
15398
- slug: Parameters.Slug;
15844
+ export interface QueryParameters {
15845
+ schema: Parameters.Schema;
15846
+ }
15847
+ namespace Responses {
15848
+ export type $200 = /**
15849
+ * Progress of an import job. The fields `dry_run`, `unique_key`, `outcome_counts`, `report_url`,
15850
+ * `S3Reference` and `started_by` are only set for jobs started with `unique_key`, `dry_run` or `dry_run_job_id`. For those,
15851
+ * `importedEntitiesCount` is `create` plus `update` and `failedEntitiesCount` counts `error` rows only.
15852
+ *
15853
+ */
15854
+ Components.Schemas.ImportProgress;
15855
+ export interface $400 {
15856
+ }
15857
+ export interface $403 {
15858
+ }
15859
+ export interface $404 {
15860
+ }
15861
+ export type $429 = /**
15862
+ * A generic error returned by the API
15863
+ * example:
15864
+ * {
15865
+ * "status": 429,
15866
+ * "error": "Too many requests. Try again later."
15867
+ * }
15868
+ */
15869
+ Components.Responses.TooManyRequestsError;
15870
+ }
15871
+ }
15872
+ namespace GetRelatedEntitiesCount {
15873
+ namespace Parameters {
15874
+ export type ExcludeSchemas = /**
15875
+ * URL-friendly identifier for the entity schema
15876
+ * example:
15877
+ * contact
15878
+ */
15879
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
15880
+ export type Id = Components.Schemas.EntityId /* uuid */;
15881
+ export type Slug = /**
15882
+ * URL-friendly identifier for the entity schema
15883
+ * example:
15884
+ * contact
15885
+ */
15886
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
15887
+ }
15888
+ export interface PathParameters {
15889
+ slug: Parameters.Slug;
15399
15890
  id: Parameters.Id;
15400
15891
  }
15401
15892
  export interface QueryParameters {
@@ -15801,6 +16292,40 @@ declare namespace Paths {
15801
16292
  Components.Responses.NotFoundError;
15802
16293
  }
15803
16294
  }
16295
+ namespace GetSchemaHead {
16296
+ namespace Parameters {
16297
+ export type Slug = /**
16298
+ * URL-friendly identifier for the entity schema
16299
+ * example:
16300
+ * contact
16301
+ */
16302
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
16303
+ }
16304
+ export interface PathParameters {
16305
+ slug: Parameters.Slug;
16306
+ }
16307
+ namespace Responses {
16308
+ export type $200 = Components.Schemas.SchemaHead;
16309
+ export type $404 = /**
16310
+ * A generic error returned by the API
16311
+ * example:
16312
+ * {
16313
+ * "status": 404,
16314
+ * "error": "Not Found"
16315
+ * }
16316
+ */
16317
+ Components.Responses.NotFoundError;
16318
+ export type $429 = /**
16319
+ * A generic error returned by the API
16320
+ * example:
16321
+ * {
16322
+ * "status": 429,
16323
+ * "error": "Too many requests. Try again later."
16324
+ * }
16325
+ */
16326
+ Components.Responses.TooManyRequestsError;
16327
+ }
16328
+ }
15804
16329
  namespace GetSchemaVersions {
15805
16330
  namespace Parameters {
15806
16331
  export type DraftsFrom = number;
@@ -15991,8 +16516,13 @@ declare namespace Paths {
15991
16516
  }
15992
16517
  export type RequestBody = /* The parameters for importing entities. */ Components.Schemas.EntityImportParams;
15993
16518
  namespace Responses {
15994
- export interface $201 {
15995
- }
16519
+ export type $201 = /**
16520
+ * Progress of an import job. The fields `dry_run`, `unique_key`, `outcome_counts`, `report_url`,
16521
+ * `S3Reference` and `started_by` are only set for jobs started with `unique_key`, `dry_run` or `dry_run_job_id`. For those,
16522
+ * `importedEntitiesCount` is `create` plus `update` and `failedEntitiesCount` counts `error` rows only.
16523
+ *
16524
+ */
16525
+ Components.Schemas.ImportProgress;
15996
16526
  export type $429 = /**
15997
16527
  * A generic error returned by the API
15998
16528
  * example:
@@ -16206,6 +16736,19 @@ declare namespace Paths {
16206
16736
  }
16207
16737
  }
16208
16738
  }
16739
+ namespace ListWipeJobs {
16740
+ namespace Parameters {
16741
+ export type Limit = number;
16742
+ }
16743
+ export interface QueryParameters {
16744
+ limit?: Parameters.Limit;
16745
+ }
16746
+ namespace Responses {
16747
+ export interface $200 {
16748
+ results: /* A request to wipe entity data of an organization, and its progress */ Components.Schemas.WipeJob[];
16749
+ }
16750
+ }
16751
+ }
16209
16752
  namespace PatchEntity {
16210
16753
  namespace Parameters {
16211
16754
  export type ActivityId = /**
@@ -16342,6 +16885,8 @@ declare namespace Paths {
16342
16885
  }
16343
16886
  namespace PutSchema {
16344
16887
  namespace Parameters {
16888
+ export type BaseUpdatedAt = string; // date-time
16889
+ export type BaseVersion = number;
16345
16890
  export type Draft = boolean;
16346
16891
  export type Slug = /**
16347
16892
  * URL-friendly identifier for the entity schema
@@ -16355,10 +16900,13 @@ declare namespace Paths {
16355
16900
  }
16356
16901
  export interface QueryParameters {
16357
16902
  draft?: Parameters.Draft;
16903
+ base_version?: Parameters.BaseVersion;
16904
+ base_updated_at?: Parameters.BaseUpdatedAt /* date-time */;
16358
16905
  }
16359
16906
  export type RequestBody = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchema;
16360
16907
  namespace Responses {
16361
16908
  export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
16909
+ export type $409 = Components.Schemas.SchemaVersionConflictError;
16362
16910
  export type $429 = /**
16363
16911
  * A generic error returned by the API
16364
16912
  * example:
@@ -17328,68 +17876,616 @@ declare namespace Paths {
17328
17876
  */
17329
17877
  Parameters.Slug /* ^[a-zA-Z0-9_-]+$ */;
17330
17878
  }
17331
- export type RequestBody = /**
17332
- * example:
17333
- * {
17334
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
17335
- * "_org": "123",
17336
- * "_owners": [
17337
- * {
17338
- * "org_id": "123",
17339
- * "user_id": "123"
17340
- * }
17341
- * ],
17342
- * "_schema": "contact",
17343
- * "_tags": [
17344
- * "example",
17345
- * "mock"
17346
- * ],
17347
- * "_created_at": "2021-02-09T12:41:43.662Z",
17348
- * "_updated_at": "2021-02-09T12:41:43.662Z",
17349
- * "_acl": {
17350
- * "view": [
17351
- * "org:456",
17352
- * "org:789"
17353
- * ],
17354
- * "edit": [
17355
- * "org:456"
17356
- * ],
17357
- * "delete": [
17358
- * "org:456"
17359
- * ]
17360
- * },
17361
- * "_manifest": [
17362
- * "123e4567-e89b-12d3-a456-426614174000"
17363
- * ]
17364
- * }
17365
- */
17366
- Components.Schemas.Entity;
17879
+ export type RequestBody = /**
17880
+ * example:
17881
+ * {
17882
+ * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
17883
+ * "_org": "123",
17884
+ * "_owners": [
17885
+ * {
17886
+ * "org_id": "123",
17887
+ * "user_id": "123"
17888
+ * }
17889
+ * ],
17890
+ * "_schema": "contact",
17891
+ * "_tags": [
17892
+ * "example",
17893
+ * "mock"
17894
+ * ],
17895
+ * "_created_at": "2021-02-09T12:41:43.662Z",
17896
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
17897
+ * "_acl": {
17898
+ * "view": [
17899
+ * "org:456",
17900
+ * "org:789"
17901
+ * ],
17902
+ * "edit": [
17903
+ * "org:456"
17904
+ * ],
17905
+ * "delete": [
17906
+ * "org:456"
17907
+ * ]
17908
+ * },
17909
+ * "_manifest": [
17910
+ * "123e4567-e89b-12d3-a456-426614174000"
17911
+ * ]
17912
+ * }
17913
+ */
17914
+ Components.Schemas.Entity;
17915
+ namespace Responses {
17916
+ export type $200 = /* Validation result for a successful validation */ Components.Schemas.EntityValidationV2ResultSuccess;
17917
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
17918
+ export type $429 = /**
17919
+ * A generic error returned by the API
17920
+ * example:
17921
+ * {
17922
+ * "status": 429,
17923
+ * "error": "Too many requests. Try again later."
17924
+ * }
17925
+ */
17926
+ Components.Responses.TooManyRequestsError;
17927
+ }
17928
+ }
17929
+ namespace WipeAllEntities {
17930
+ export interface RequestBody {
17931
+ /**
17932
+ * Schemas to wipe. Omit to wipe all schemas. An empty array is rejected with 400.
17933
+ */
17934
+ schemas?: [
17935
+ /**
17936
+ * URL-friendly identifier for the entity schema
17937
+ * example:
17938
+ * contact
17939
+ */
17940
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17941
+ /**
17942
+ * URL-friendly identifier for the entity schema
17943
+ * example:
17944
+ * contact
17945
+ */
17946
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17947
+ /**
17948
+ * URL-friendly identifier for the entity schema
17949
+ * example:
17950
+ * contact
17951
+ */
17952
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17953
+ /**
17954
+ * URL-friendly identifier for the entity schema
17955
+ * example:
17956
+ * contact
17957
+ */
17958
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17959
+ /**
17960
+ * URL-friendly identifier for the entity schema
17961
+ * example:
17962
+ * contact
17963
+ */
17964
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17965
+ /**
17966
+ * URL-friendly identifier for the entity schema
17967
+ * example:
17968
+ * contact
17969
+ */
17970
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17971
+ /**
17972
+ * URL-friendly identifier for the entity schema
17973
+ * example:
17974
+ * contact
17975
+ */
17976
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17977
+ /**
17978
+ * URL-friendly identifier for the entity schema
17979
+ * example:
17980
+ * contact
17981
+ */
17982
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17983
+ /**
17984
+ * URL-friendly identifier for the entity schema
17985
+ * example:
17986
+ * contact
17987
+ */
17988
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17989
+ /**
17990
+ * URL-friendly identifier for the entity schema
17991
+ * example:
17992
+ * contact
17993
+ */
17994
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
17995
+ /**
17996
+ * URL-friendly identifier for the entity schema
17997
+ * example:
17998
+ * contact
17999
+ */
18000
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18001
+ /**
18002
+ * URL-friendly identifier for the entity schema
18003
+ * example:
18004
+ * contact
18005
+ */
18006
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18007
+ /**
18008
+ * URL-friendly identifier for the entity schema
18009
+ * example:
18010
+ * contact
18011
+ */
18012
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18013
+ /**
18014
+ * URL-friendly identifier for the entity schema
18015
+ * example:
18016
+ * contact
18017
+ */
18018
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18019
+ /**
18020
+ * URL-friendly identifier for the entity schema
18021
+ * example:
18022
+ * contact
18023
+ */
18024
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18025
+ /**
18026
+ * URL-friendly identifier for the entity schema
18027
+ * example:
18028
+ * contact
18029
+ */
18030
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18031
+ /**
18032
+ * URL-friendly identifier for the entity schema
18033
+ * example:
18034
+ * contact
18035
+ */
18036
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18037
+ /**
18038
+ * URL-friendly identifier for the entity schema
18039
+ * example:
18040
+ * contact
18041
+ */
18042
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18043
+ /**
18044
+ * URL-friendly identifier for the entity schema
18045
+ * example:
18046
+ * contact
18047
+ */
18048
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18049
+ /**
18050
+ * URL-friendly identifier for the entity schema
18051
+ * example:
18052
+ * contact
18053
+ */
18054
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18055
+ /**
18056
+ * URL-friendly identifier for the entity schema
18057
+ * example:
18058
+ * contact
18059
+ */
18060
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18061
+ /**
18062
+ * URL-friendly identifier for the entity schema
18063
+ * example:
18064
+ * contact
18065
+ */
18066
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18067
+ /**
18068
+ * URL-friendly identifier for the entity schema
18069
+ * example:
18070
+ * contact
18071
+ */
18072
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18073
+ /**
18074
+ * URL-friendly identifier for the entity schema
18075
+ * example:
18076
+ * contact
18077
+ */
18078
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18079
+ /**
18080
+ * URL-friendly identifier for the entity schema
18081
+ * example:
18082
+ * contact
18083
+ */
18084
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18085
+ /**
18086
+ * URL-friendly identifier for the entity schema
18087
+ * example:
18088
+ * contact
18089
+ */
18090
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18091
+ /**
18092
+ * URL-friendly identifier for the entity schema
18093
+ * example:
18094
+ * contact
18095
+ */
18096
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18097
+ /**
18098
+ * URL-friendly identifier for the entity schema
18099
+ * example:
18100
+ * contact
18101
+ */
18102
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18103
+ /**
18104
+ * URL-friendly identifier for the entity schema
18105
+ * example:
18106
+ * contact
18107
+ */
18108
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18109
+ /**
18110
+ * URL-friendly identifier for the entity schema
18111
+ * example:
18112
+ * contact
18113
+ */
18114
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18115
+ /**
18116
+ * URL-friendly identifier for the entity schema
18117
+ * example:
18118
+ * contact
18119
+ */
18120
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18121
+ /**
18122
+ * URL-friendly identifier for the entity schema
18123
+ * example:
18124
+ * contact
18125
+ */
18126
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18127
+ /**
18128
+ * URL-friendly identifier for the entity schema
18129
+ * example:
18130
+ * contact
18131
+ */
18132
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18133
+ /**
18134
+ * URL-friendly identifier for the entity schema
18135
+ * example:
18136
+ * contact
18137
+ */
18138
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18139
+ /**
18140
+ * URL-friendly identifier for the entity schema
18141
+ * example:
18142
+ * contact
18143
+ */
18144
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18145
+ /**
18146
+ * URL-friendly identifier for the entity schema
18147
+ * example:
18148
+ * contact
18149
+ */
18150
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18151
+ /**
18152
+ * URL-friendly identifier for the entity schema
18153
+ * example:
18154
+ * contact
18155
+ */
18156
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18157
+ /**
18158
+ * URL-friendly identifier for the entity schema
18159
+ * example:
18160
+ * contact
18161
+ */
18162
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18163
+ /**
18164
+ * URL-friendly identifier for the entity schema
18165
+ * example:
18166
+ * contact
18167
+ */
18168
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18169
+ /**
18170
+ * URL-friendly identifier for the entity schema
18171
+ * example:
18172
+ * contact
18173
+ */
18174
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18175
+ /**
18176
+ * URL-friendly identifier for the entity schema
18177
+ * example:
18178
+ * contact
18179
+ */
18180
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18181
+ /**
18182
+ * URL-friendly identifier for the entity schema
18183
+ * example:
18184
+ * contact
18185
+ */
18186
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18187
+ /**
18188
+ * URL-friendly identifier for the entity schema
18189
+ * example:
18190
+ * contact
18191
+ */
18192
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18193
+ /**
18194
+ * URL-friendly identifier for the entity schema
18195
+ * example:
18196
+ * contact
18197
+ */
18198
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18199
+ /**
18200
+ * URL-friendly identifier for the entity schema
18201
+ * example:
18202
+ * contact
18203
+ */
18204
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18205
+ /**
18206
+ * URL-friendly identifier for the entity schema
18207
+ * example:
18208
+ * contact
18209
+ */
18210
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18211
+ /**
18212
+ * URL-friendly identifier for the entity schema
18213
+ * example:
18214
+ * contact
18215
+ */
18216
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18217
+ /**
18218
+ * URL-friendly identifier for the entity schema
18219
+ * example:
18220
+ * contact
18221
+ */
18222
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18223
+ /**
18224
+ * URL-friendly identifier for the entity schema
18225
+ * example:
18226
+ * contact
18227
+ */
18228
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18229
+ /**
18230
+ * URL-friendly identifier for the entity schema
18231
+ * example:
18232
+ * contact
18233
+ */
18234
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18235
+ /**
18236
+ * URL-friendly identifier for the entity schema
18237
+ * example:
18238
+ * contact
18239
+ */
18240
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18241
+ /**
18242
+ * URL-friendly identifier for the entity schema
18243
+ * example:
18244
+ * contact
18245
+ */
18246
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18247
+ /**
18248
+ * URL-friendly identifier for the entity schema
18249
+ * example:
18250
+ * contact
18251
+ */
18252
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18253
+ /**
18254
+ * URL-friendly identifier for the entity schema
18255
+ * example:
18256
+ * contact
18257
+ */
18258
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18259
+ /**
18260
+ * URL-friendly identifier for the entity schema
18261
+ * example:
18262
+ * contact
18263
+ */
18264
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18265
+ /**
18266
+ * URL-friendly identifier for the entity schema
18267
+ * example:
18268
+ * contact
18269
+ */
18270
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18271
+ /**
18272
+ * URL-friendly identifier for the entity schema
18273
+ * example:
18274
+ * contact
18275
+ */
18276
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18277
+ /**
18278
+ * URL-friendly identifier for the entity schema
18279
+ * example:
18280
+ * contact
18281
+ */
18282
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18283
+ /**
18284
+ * URL-friendly identifier for the entity schema
18285
+ * example:
18286
+ * contact
18287
+ */
18288
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18289
+ /**
18290
+ * URL-friendly identifier for the entity schema
18291
+ * example:
18292
+ * contact
18293
+ */
18294
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18295
+ /**
18296
+ * URL-friendly identifier for the entity schema
18297
+ * example:
18298
+ * contact
18299
+ */
18300
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18301
+ /**
18302
+ * URL-friendly identifier for the entity schema
18303
+ * example:
18304
+ * contact
18305
+ */
18306
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18307
+ /**
18308
+ * URL-friendly identifier for the entity schema
18309
+ * example:
18310
+ * contact
18311
+ */
18312
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18313
+ /**
18314
+ * URL-friendly identifier for the entity schema
18315
+ * example:
18316
+ * contact
18317
+ */
18318
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18319
+ /**
18320
+ * URL-friendly identifier for the entity schema
18321
+ * example:
18322
+ * contact
18323
+ */
18324
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18325
+ /**
18326
+ * URL-friendly identifier for the entity schema
18327
+ * example:
18328
+ * contact
18329
+ */
18330
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18331
+ /**
18332
+ * URL-friendly identifier for the entity schema
18333
+ * example:
18334
+ * contact
18335
+ */
18336
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18337
+ /**
18338
+ * URL-friendly identifier for the entity schema
18339
+ * example:
18340
+ * contact
18341
+ */
18342
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18343
+ /**
18344
+ * URL-friendly identifier for the entity schema
18345
+ * example:
18346
+ * contact
18347
+ */
18348
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18349
+ /**
18350
+ * URL-friendly identifier for the entity schema
18351
+ * example:
18352
+ * contact
18353
+ */
18354
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18355
+ /**
18356
+ * URL-friendly identifier for the entity schema
18357
+ * example:
18358
+ * contact
18359
+ */
18360
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18361
+ /**
18362
+ * URL-friendly identifier for the entity schema
18363
+ * example:
18364
+ * contact
18365
+ */
18366
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18367
+ /**
18368
+ * URL-friendly identifier for the entity schema
18369
+ * example:
18370
+ * contact
18371
+ */
18372
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18373
+ /**
18374
+ * URL-friendly identifier for the entity schema
18375
+ * example:
18376
+ * contact
18377
+ */
18378
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18379
+ /**
18380
+ * URL-friendly identifier for the entity schema
18381
+ * example:
18382
+ * contact
18383
+ */
18384
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18385
+ /**
18386
+ * URL-friendly identifier for the entity schema
18387
+ * example:
18388
+ * contact
18389
+ */
18390
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18391
+ /**
18392
+ * URL-friendly identifier for the entity schema
18393
+ * example:
18394
+ * contact
18395
+ */
18396
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18397
+ /**
18398
+ * URL-friendly identifier for the entity schema
18399
+ * example:
18400
+ * contact
18401
+ */
18402
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18403
+ /**
18404
+ * URL-friendly identifier for the entity schema
18405
+ * example:
18406
+ * contact
18407
+ */
18408
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18409
+ /**
18410
+ * URL-friendly identifier for the entity schema
18411
+ * example:
18412
+ * contact
18413
+ */
18414
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18415
+ /**
18416
+ * URL-friendly identifier for the entity schema
18417
+ * example:
18418
+ * contact
18419
+ */
18420
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18421
+ /**
18422
+ * URL-friendly identifier for the entity schema
18423
+ * example:
18424
+ * contact
18425
+ */
18426
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18427
+ /**
18428
+ * URL-friendly identifier for the entity schema
18429
+ * example:
18430
+ * contact
18431
+ */
18432
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18433
+ /**
18434
+ * URL-friendly identifier for the entity schema
18435
+ * example:
18436
+ * contact
18437
+ */
18438
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18439
+ /**
18440
+ * URL-friendly identifier for the entity schema
18441
+ * example:
18442
+ * contact
18443
+ */
18444
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18445
+ /**
18446
+ * URL-friendly identifier for the entity schema
18447
+ * example:
18448
+ * contact
18449
+ */
18450
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18451
+ /**
18452
+ * URL-friendly identifier for the entity schema
18453
+ * example:
18454
+ * contact
18455
+ */
18456
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18457
+ /**
18458
+ * URL-friendly identifier for the entity schema
18459
+ * example:
18460
+ * contact
18461
+ */
18462
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18463
+ /**
18464
+ * URL-friendly identifier for the entity schema
18465
+ * example:
18466
+ * contact
18467
+ */
18468
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?,
18469
+ /**
18470
+ * URL-friendly identifier for the entity schema
18471
+ * example:
18472
+ * contact
18473
+ */
18474
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */?
18475
+ ];
18476
+ }
17367
18477
  namespace Responses {
17368
- export type $200 = /* Validation result for a successful validation */ Components.Schemas.EntityValidationV2ResultSuccess;
17369
- export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
17370
- export type $429 = /**
18478
+ export type $201 = /* A request to wipe entity data of an organization, and its progress */ Components.Schemas.WipeJob;
18479
+ export type $400 = /**
17371
18480
  * A generic error returned by the API
17372
18481
  * example:
17373
18482
  * {
17374
- * "status": 429,
17375
- * "error": "Too many requests. Try again later."
18483
+ * "status": 400,
18484
+ * "error": "Bad Request"
17376
18485
  * }
17377
18486
  */
17378
- Components.Responses.TooManyRequestsError;
17379
- }
17380
- }
17381
- namespace WipeAllEntities {
17382
- export interface RequestBody {
17383
- schemas?: /**
17384
- * URL-friendly identifier for the entity schema
17385
- * example:
17386
- * contact
17387
- */
17388
- Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
17389
- }
17390
- namespace Responses {
17391
- export interface $201 {
17392
- }
18487
+ Components.Responses.BadRequestError;
18488
+ export type $409 = Components.Schemas.WipeJobConflictError;
17393
18489
  }
17394
18490
  }
17395
18491
  }
@@ -17452,6 +18548,18 @@ interface OperationMethods {
17452
18548
  data?: any,
17453
18549
  config?: AxiosRequestConfig
17454
18550
  ): OperationResponse<Paths.DeleteSchema.Responses.$200>
18551
+ /**
18552
+ * getSchemaHead - getSchemaHead
18553
+ *
18554
+ * Lightweight lookup of the schema version saves currently land on top of. Meant for editors
18555
+ * to detect that someone else saved while they were editing, without fetching the schema.
18556
+ *
18557
+ */
18558
+ 'getSchemaHead'(
18559
+ parameters?: Parameters<Paths.GetSchemaHead.PathParameters> | null,
18560
+ data?: any,
18561
+ config?: AxiosRequestConfig
18562
+ ): OperationResponse<Paths.GetSchemaHead.Responses.$200>
17455
18563
  /**
17456
18564
  * getJsonSchema - getJsonSchema
17457
18565
  *
@@ -17936,12 +19044,30 @@ interface OperationMethods {
17936
19044
  *
17937
19045
  * Creates a request to queue the deletion of all entities in the system. This is a destructive operation and should only be used in sandbox environments.
17938
19046
  *
19047
+ * The request is persisted as a wipe job whose progress can be followed with `listWipeJobs`.
19048
+ * Omit `schemas` to wipe all schemas of the organization. An empty `schemas` array is rejected.
19049
+ *
19050
+ * Only one wipe can run per schema at a time: a request that overlaps a running wipe
19051
+ * (same schema, or any schema while a wipe of all schemas is running) is rejected with `409`.
19052
+ * Wipe executions are limited to 23 hours so they stop before their 24-hour locks expire.
19053
+ *
17939
19054
  */
17940
19055
  'wipeAllEntities'(
17941
19056
  parameters?: Parameters<UnknownParamsObject> | null,
17942
19057
  data?: Paths.WipeAllEntities.RequestBody,
17943
19058
  config?: AxiosRequestConfig
17944
19059
  ): OperationResponse<Paths.WipeAllEntities.Responses.$201>
19060
+ /**
19061
+ * listWipeJobs - listWipeJobs
19062
+ *
19063
+ * Lists the most recent wipe jobs of the organization, newest first.
19064
+ *
19065
+ */
19066
+ 'listWipeJobs'(
19067
+ parameters?: Parameters<Paths.ListWipeJobs.QueryParameters> | null,
19068
+ data?: any,
19069
+ config?: AxiosRequestConfig
19070
+ ): OperationResponse<Paths.ListWipeJobs.Responses.$200>
17945
19071
  /**
17946
19072
  * createActivity - createActivity
17947
19073
  *
@@ -18021,6 +19147,18 @@ interface OperationMethods {
18021
19147
  data?: any,
18022
19148
  config?: AxiosRequestConfig
18023
19149
  ): OperationResponse<Paths.GetEntityActivityFeed.Responses.$200>
19150
+ /**
19151
+ * getEntitySummary - getEntitySummary
19152
+ *
19153
+ * Get the latest AI generated summary of an entity. Summaries are generated by the
19154
+ * ai-agents-api `skill:entity-summary` and stored here when the execution completes.
19155
+ *
19156
+ */
19157
+ 'getEntitySummary'(
19158
+ parameters?: Parameters<Paths.GetEntitySummary.PathParameters> | null,
19159
+ data?: any,
19160
+ config?: AxiosRequestConfig
19161
+ ): OperationResponse<Paths.GetEntitySummary.Responses.$200>
18024
19162
  /**
18025
19163
  * getRelations - getRelations
18026
19164
  *
@@ -18144,6 +19282,33 @@ interface OperationMethods {
18144
19282
  data?: Paths.ImportEntities.RequestBody,
18145
19283
  config?: AxiosRequestConfig
18146
19284
  ): OperationResponse<Paths.ImportEntities.Responses.$201>
19285
+ /**
19286
+ * getLatestEntityImport - Get the latest import job of a schema
19287
+ *
19288
+ * Returns the progress of the latest import job for the organization and schema: the running job,
19289
+ * whoever started it (it blocks every other import of the schema), otherwise the caller's own last
19290
+ * finished job if it finished within the last 24 hours. Used to show the state of an import (or dry
19291
+ * run) that was started earlier.
19292
+ *
19293
+ */
19294
+ 'getLatestEntityImport'(
19295
+ parameters?: Parameters<Paths.GetLatestEntityImport.QueryParameters> | null,
19296
+ data?: any,
19297
+ config?: AxiosRequestConfig
19298
+ ): OperationResponse<Paths.GetLatestEntityImport.Responses.$200>
19299
+ /**
19300
+ * getEntityImportHistory - List the import jobs of a schema
19301
+ *
19302
+ * Lists the import jobs (imports and dry runs) of a schema in the organization, newest first: the
19303
+ * running job, if any, then the jobs that ended in the last 30 days. Every caller with access sees
19304
+ * every job. Without jobs the list is empty; this operation does not answer 404.
19305
+ *
19306
+ */
19307
+ 'getEntityImportHistory'(
19308
+ parameters?: Parameters<Paths.GetEntityImportHistory.QueryParameters> | null,
19309
+ data?: any,
19310
+ config?: AxiosRequestConfig
19311
+ ): OperationResponse<Paths.GetEntityImportHistory.Responses.$200>
18147
19312
  /**
18148
19313
  * abortEntityImport - Abort a running entity import
18149
19314
  *
@@ -18163,6 +19328,25 @@ interface OperationMethods {
18163
19328
  data?: any,
18164
19329
  config?: AxiosRequestConfig
18165
19330
  ): OperationResponse<Paths.AbortEntityImport.Responses.$202>
19331
+ /**
19332
+ * discardEntityImport - Discard a finished dry run
19333
+ *
19334
+ * Discards a dry run that has finished (`COMPLETED`), so it is no longer offered for import.
19335
+ * The job becomes `CANCELLED` and `GET /v1/entity:import:latest` stops returning it as ready.
19336
+ * For a file that requires a dry run (more than 50 rows), an import passing it as
19337
+ * `dry_run_job_id` then fails with `dry_run_required`. The dry run wrote nothing, and its
19338
+ * report stays available.
19339
+ *
19340
+ * Only the user who ran the dry run can discard it (403 otherwise). Idempotent - discarding an
19341
+ * already discarded dry run answers 200. A running dry run is stopped with
19342
+ * `POST /v1/entity:abortImport` instead.
19343
+ *
19344
+ */
19345
+ 'discardEntityImport'(
19346
+ parameters?: Parameters<Paths.DiscardEntityImport.QueryParameters> | null,
19347
+ data?: any,
19348
+ config?: AxiosRequestConfig
19349
+ ): OperationResponse<Paths.DiscardEntityImport.Responses.$200>
18166
19350
  /**
18167
19351
  * listSavedViews - listSavedViews
18168
19352
  *
@@ -18666,6 +19850,20 @@ interface PathsDictionary {
18666
19850
  config?: AxiosRequestConfig
18667
19851
  ): OperationResponse<Paths.DeleteSchema.Responses.$200>
18668
19852
  }
19853
+ ['/v1/entity/schemas/{slug}/head']: {
19854
+ /**
19855
+ * getSchemaHead - getSchemaHead
19856
+ *
19857
+ * Lightweight lookup of the schema version saves currently land on top of. Meant for editors
19858
+ * to detect that someone else saved while they were editing, without fetching the schema.
19859
+ *
19860
+ */
19861
+ 'get'(
19862
+ parameters?: Parameters<Paths.GetSchemaHead.PathParameters> | null,
19863
+ data?: any,
19864
+ config?: AxiosRequestConfig
19865
+ ): OperationResponse<Paths.GetSchemaHead.Responses.$200>
19866
+ }
18669
19867
  ['/v1/entity/schemas/{slug}/json/schema']: {
18670
19868
  /**
18671
19869
  * getJsonSchema - getJsonSchema
@@ -19189,6 +20387,13 @@ interface PathsDictionary {
19189
20387
  *
19190
20388
  * Creates a request to queue the deletion of all entities in the system. This is a destructive operation and should only be used in sandbox environments.
19191
20389
  *
20390
+ * The request is persisted as a wipe job whose progress can be followed with `listWipeJobs`.
20391
+ * Omit `schemas` to wipe all schemas of the organization. An empty `schemas` array is rejected.
20392
+ *
20393
+ * Only one wipe can run per schema at a time: a request that overlaps a running wipe
20394
+ * (same schema, or any schema while a wipe of all schemas is running) is rejected with `409`.
20395
+ * Wipe executions are limited to 23 hours so they stop before their 24-hour locks expire.
20396
+ *
19192
20397
  */
19193
20398
  'post'(
19194
20399
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -19196,6 +20401,19 @@ interface PathsDictionary {
19196
20401
  config?: AxiosRequestConfig
19197
20402
  ): OperationResponse<Paths.WipeAllEntities.Responses.$201>
19198
20403
  }
20404
+ ['/v1/entity:wipeJobs']: {
20405
+ /**
20406
+ * listWipeJobs - listWipeJobs
20407
+ *
20408
+ * Lists the most recent wipe jobs of the organization, newest first.
20409
+ *
20410
+ */
20411
+ 'get'(
20412
+ parameters?: Parameters<Paths.ListWipeJobs.QueryParameters> | null,
20413
+ data?: any,
20414
+ config?: AxiosRequestConfig
20415
+ ): OperationResponse<Paths.ListWipeJobs.Responses.$200>
20416
+ }
19199
20417
  ['/v1/entity/activity']: {
19200
20418
  /**
19201
20419
  * createActivity - createActivity
@@ -19289,6 +20507,20 @@ interface PathsDictionary {
19289
20507
  config?: AxiosRequestConfig
19290
20508
  ): OperationResponse<Paths.GetEntityActivityFeed.Responses.$200>
19291
20509
  }
20510
+ ['/v1/entity/{slug}/{id}/summary']: {
20511
+ /**
20512
+ * getEntitySummary - getEntitySummary
20513
+ *
20514
+ * Get the latest AI generated summary of an entity. Summaries are generated by the
20515
+ * ai-agents-api `skill:entity-summary` and stored here when the execution completes.
20516
+ *
20517
+ */
20518
+ 'get'(
20519
+ parameters?: Parameters<Paths.GetEntitySummary.PathParameters> | null,
20520
+ data?: any,
20521
+ config?: AxiosRequestConfig
20522
+ ): OperationResponse<Paths.GetEntitySummary.Responses.$200>
20523
+ }
19292
20524
  ['/v1/entity/{slug}/{id}/relations']: {
19293
20525
  /**
19294
20526
  * getRelations - getRelations
@@ -19426,6 +20658,37 @@ interface PathsDictionary {
19426
20658
  config?: AxiosRequestConfig
19427
20659
  ): OperationResponse<Paths.ImportEntities.Responses.$201>
19428
20660
  }
20661
+ ['/v1/entity:import:latest']: {
20662
+ /**
20663
+ * getLatestEntityImport - Get the latest import job of a schema
20664
+ *
20665
+ * Returns the progress of the latest import job for the organization and schema: the running job,
20666
+ * whoever started it (it blocks every other import of the schema), otherwise the caller's own last
20667
+ * finished job if it finished within the last 24 hours. Used to show the state of an import (or dry
20668
+ * run) that was started earlier.
20669
+ *
20670
+ */
20671
+ 'get'(
20672
+ parameters?: Parameters<Paths.GetLatestEntityImport.QueryParameters> | null,
20673
+ data?: any,
20674
+ config?: AxiosRequestConfig
20675
+ ): OperationResponse<Paths.GetLatestEntityImport.Responses.$200>
20676
+ }
20677
+ ['/v1/entity:importHistory']: {
20678
+ /**
20679
+ * getEntityImportHistory - List the import jobs of a schema
20680
+ *
20681
+ * Lists the import jobs (imports and dry runs) of a schema in the organization, newest first: the
20682
+ * running job, if any, then the jobs that ended in the last 30 days. Every caller with access sees
20683
+ * every job. Without jobs the list is empty; this operation does not answer 404.
20684
+ *
20685
+ */
20686
+ 'get'(
20687
+ parameters?: Parameters<Paths.GetEntityImportHistory.QueryParameters> | null,
20688
+ data?: any,
20689
+ config?: AxiosRequestConfig
20690
+ ): OperationResponse<Paths.GetEntityImportHistory.Responses.$200>
20691
+ }
19429
20692
  ['/v1/entity:abortImport']: {
19430
20693
  /**
19431
20694
  * abortEntityImport - Abort a running entity import
@@ -19447,6 +20710,27 @@ interface PathsDictionary {
19447
20710
  config?: AxiosRequestConfig
19448
20711
  ): OperationResponse<Paths.AbortEntityImport.Responses.$202>
19449
20712
  }
20713
+ ['/v1/entity:discardImport']: {
20714
+ /**
20715
+ * discardEntityImport - Discard a finished dry run
20716
+ *
20717
+ * Discards a dry run that has finished (`COMPLETED`), so it is no longer offered for import.
20718
+ * The job becomes `CANCELLED` and `GET /v1/entity:import:latest` stops returning it as ready.
20719
+ * For a file that requires a dry run (more than 50 rows), an import passing it as
20720
+ * `dry_run_job_id` then fails with `dry_run_required`. The dry run wrote nothing, and its
20721
+ * report stays available.
20722
+ *
20723
+ * Only the user who ran the dry run can discard it (403 otherwise). Idempotent - discarding an
20724
+ * already discarded dry run answers 200. A running dry run is stopped with
20725
+ * `POST /v1/entity:abortImport` instead.
20726
+ *
20727
+ */
20728
+ 'post'(
20729
+ parameters?: Parameters<Paths.DiscardEntityImport.QueryParameters> | null,
20730
+ data?: any,
20731
+ config?: AxiosRequestConfig
20732
+ ): OperationResponse<Paths.DiscardEntityImport.Responses.$200>
20733
+ }
19450
20734
  ['/v1/entity/views']: {
19451
20735
  /**
19452
20736
  * listSavedViews - listSavedViews
@@ -20001,6 +21285,7 @@ type EntitySearchOptions = Components.Schemas.EntitySearchOptions;
20001
21285
  type EntitySearchParams = Components.Schemas.EntitySearchParams;
20002
21286
  type EntitySearchResults = Components.Schemas.EntitySearchResults;
20003
21287
  type EntitySlug = Components.Schemas.EntitySlug;
21288
+ type EntitySummary = Components.Schemas.EntitySummary;
20004
21289
  type EntityTableFilterOption = Components.Schemas.EntityTableFilterOption;
20005
21290
  type EntityTableFilterSearch = Components.Schemas.EntityTableFilterSearch;
20006
21291
  type EntityValidationError = Components.Schemas.EntityValidationError;
@@ -20033,6 +21318,11 @@ type GroupHeadline = Components.Schemas.GroupHeadline;
20033
21318
  type GroupHeadlineWithCompositeID = Components.Schemas.GroupHeadlineWithCompositeID;
20034
21319
  type HydratedEntity = Components.Schemas.HydratedEntity;
20035
21320
  type HydratedEntityItem = Components.Schemas.HydratedEntityItem;
21321
+ type ImportFailureCode = Components.Schemas.ImportFailureCode;
21322
+ type ImportIssue = Components.Schemas.ImportIssue;
21323
+ type ImportJobSummary = Components.Schemas.ImportJobSummary;
21324
+ type ImportProgress = Components.Schemas.ImportProgress;
21325
+ type ImportRowOutcomeCounts = Components.Schemas.ImportRowOutcomeCounts;
20036
21326
  type InternalAttribute = Components.Schemas.InternalAttribute;
20037
21327
  type InternalUserAttribute = Components.Schemas.InternalUserAttribute;
20038
21328
  type InvitationEmailAttribute = Components.Schemas.InvitationEmailAttribute;
@@ -20066,7 +21356,9 @@ type SavedViewId = Components.Schemas.SavedViewId;
20066
21356
  type SavedViewItem = Components.Schemas.SavedViewItem;
20067
21357
  type SavedViewPartial = Components.Schemas.SavedViewPartial;
20068
21358
  type ScalarConditionDefinition = Components.Schemas.ScalarConditionDefinition;
21359
+ type SchemaHead = Components.Schemas.SchemaHead;
20069
21360
  type SchemaId = Components.Schemas.SchemaId;
21361
+ type SchemaVersionConflictError = Components.Schemas.SchemaVersionConflictError;
20070
21362
  type SearchFilter = Components.Schemas.SearchFilter;
20071
21363
  type SearchFilterValue = Components.Schemas.SearchFilterValue;
20072
21364
  type SearchMappings = Components.Schemas.SearchMappings;
@@ -20090,5 +21382,7 @@ type TaxonomySearchIncludeArchivedParam = Components.Schemas.TaxonomySearchInclu
20090
21382
  type TaxonomySlug = Components.Schemas.TaxonomySlug;
20091
21383
  type TextAttribute = Components.Schemas.TextAttribute;
20092
21384
  type UserRelationAttribute = Components.Schemas.UserRelationAttribute;
21385
+ type WipeJob = Components.Schemas.WipeJob;
21386
+ type WipeJobConflictError = Components.Schemas.WipeJobConflictError;
20093
21387
 
20094
- export { type EntityOperation as $, type Attribute as A, type BaseActivityItem as B, type Client as C, type ConsentAttribute as D, type CountryAttribute as E, type CurrencyAttribute as F, type DateAttribute as G, type DefaultAddressFields as H, type ESClusterAssignment as I, type EditMode as J, type EditModeConfig as K, type LocationConditionDefinition as L, type EmailAttribute as M, type Entity as N, type OperationMethods as O, Paths as P, type EntityAcl as Q, type EntityAction as R, type EntityCapability as S, type EntityCapabilityWithCompositeID as T, type EntityDefaultCreate as U, type EntityDefaultEdit as V, type EntityDefaultTable as W, type EntityId as X, type EntityImportParams as Y, type EntityItem as Z, type EntityListParams as _, Components as a, type PriceComponentAttribute as a$, type EntityOperationSourceContext as a0, type EntityOwner as a1, type EntitySchema as a2, type EntitySchemaGroup as a3, type EntitySchemaGroupWithCompositeID as a4, type EntitySchemaItem as a5, type EntitySearchIncludeDeletedParam as a6, type EntitySearchOptions as a7, type EntitySearchParams as a8, type EntitySearchResults as a9, type GraphQueryRequest as aA, type GraphQueryResponse as aB, type GraphSeed as aC, type GroupHeadline as aD, type GroupHeadlineWithCompositeID as aE, type HydratedEntity as aF, type HydratedEntityItem as aG, type InternalAttribute as aH, type InternalUserAttribute as aI, type InvitationEmailAttribute as aJ, type IsTemplate as aK, type Language as aL, type LinkAttribute as aM, type ListSavedViewsResults as aN, type MatchStrategy as aO, type MessageEmailAddressAttribute as aP, type MeterReadingChangesetEntry as aQ, type MultiSelectAttribute as aR, type NullableEntity as aS, type NumberAttribute as aT, type OrderedListAttribute as aU, type PartnerOrganisationAttribute as aV, type PartnerStatusAttribute as aW, type PaymentAttribute as aX, type PaymentMethodRelationAttribute as aY, type PhoneAttribute as aZ, type PortalAccessAttribute as a_, type EntitySlug as aa, type EntityTableFilterOption as ab, type EntityTableFilterSearch as ac, type EntityValidationError as ad, type EntityValidationResult as ae, type EntityValidationResultError as af, type EntityValidationResultSuccess as ag, type EntityValidationV2Error as ah, type EntityValidationV2Result as ai, type EntityValidationV2ResultError as aj, type EntityValidationV2ResultSuccess as ak, type EntityViewDisabled as al, type ErrorObject as am, type ExportJobId as an, type FieldsParam as ao, type FileAttribute as ap, type FuzzyConfig as aq, type GenerateEntityTableAIFiltersRequest as ar, type GenerateEntityTableAIFiltersResponse as as, GetRelatedEntitiesCount as at, type GetRelationsResp as au, type GetRelationsRespWithPagination as av, type GraphDefinition as aw, type GraphEdge as ax, type GraphNode as ay, type GraphNodeFilter as az, type PathsDictionary as b, type PurposeAttribute as b0, type RedirectEntityView as b1, type RelationAttribute as b2, type RelationEntity as b3, type RelationItem as b4, type RepeatableAttribute as b5, type SavedView as b6, type SavedViewId as b7, type SavedViewItem as b8, type SavedViewPartial as b9, type ScalarConditionDefinition as ba, type SchemaId as bb, type SearchFilter as bc, type SearchFilterValue as bd, type SearchMappings as be, type SelectAttribute as bf, type SelectConditionDefinition as bg, type SequenceAttribute as bh, type SettingFlag as bi, type StatusAttribute as bj, type SummaryAttribute as bk, type SummaryField as bl, type TableAttribute as bm, type TagsAttribute as bn, type Taxonomy as bo, type TaxonomyBulkJob as bp, type TaxonomyBulkJobActionType as bq, type TaxonomyBulkJobStatus as br, type TaxonomyBulkJobTriggerResponse as bs, type TaxonomyClassification as bt, type TaxonomyLocationId as bu, type TaxonomySearchIncludeArchivedParam as bv, type TaxonomySlug as bw, type TextAttribute as bx, type UserRelationAttribute as by, type Activity as c, type ActivityCallerContext as d, type ActivityId as e, type ActivityItem as f, type ActivityType as g, type AddressAttribute as h, type AddressRelationAttribute as i, type AdjustInstallmentCapabilityConfig as j, type AttributeWithCompositeID as k, type AutomationAttribute as l, type BaseAttribute as m, type BaseConditionDefinition as n, type BaseEntity as o, type BlueprintEntityId as p, type BooleanAttribute as q, type Changeset as r, type ChangesetCreator as s, type ChangesetMap as t, type ClassificationId as u, type ClassificationIdOrPattern as v, type ClassificationSlug as w, type ClassificationsUpdate as x, type ComputedAttribute as y, type ConditionDefinition as z };
21388
+ export { type EntityOperation as $, type Attribute as A, type BaseActivityItem as B, type Client as C, type ConsentAttribute as D, type CountryAttribute as E, type CurrencyAttribute as F, type DateAttribute as G, type DefaultAddressFields as H, type ESClusterAssignment as I, type EditMode as J, type EditModeConfig as K, type LocationConditionDefinition as L, type EmailAttribute as M, type Entity as N, type OperationMethods as O, Paths as P, type EntityAcl as Q, type EntityAction as R, type EntityCapability as S, type EntityCapabilityWithCompositeID as T, type EntityDefaultCreate as U, type EntityDefaultEdit as V, type EntityDefaultTable as W, type EntityId as X, type EntityImportParams as Y, type EntityItem as Z, type EntityListParams as _, Components as a, type PartnerOrganisationAttribute as a$, type EntityOperationSourceContext as a0, type EntityOwner as a1, type EntitySchema as a2, type EntitySchemaGroup as a3, type EntitySchemaGroupWithCompositeID as a4, type EntitySchemaItem as a5, type EntitySearchIncludeDeletedParam as a6, type EntitySearchOptions as a7, type EntitySearchParams as a8, type EntitySearchResults as a9, type GraphNodeFilter as aA, type GraphQueryRequest as aB, type GraphQueryResponse as aC, type GraphSeed as aD, type GroupHeadline as aE, type GroupHeadlineWithCompositeID as aF, type HydratedEntity as aG, type HydratedEntityItem as aH, type ImportFailureCode as aI, type ImportIssue as aJ, type ImportJobSummary as aK, type ImportProgress as aL, type ImportRowOutcomeCounts as aM, type InternalAttribute as aN, type InternalUserAttribute as aO, type InvitationEmailAttribute as aP, type IsTemplate as aQ, type Language as aR, type LinkAttribute as aS, type ListSavedViewsResults as aT, type MatchStrategy as aU, type MessageEmailAddressAttribute as aV, type MeterReadingChangesetEntry as aW, type MultiSelectAttribute as aX, type NullableEntity as aY, type NumberAttribute as aZ, type OrderedListAttribute as a_, type EntitySlug as aa, type EntitySummary as ab, type EntityTableFilterOption as ac, type EntityTableFilterSearch as ad, type EntityValidationError as ae, type EntityValidationResult as af, type EntityValidationResultError as ag, type EntityValidationResultSuccess as ah, type EntityValidationV2Error as ai, type EntityValidationV2Result as aj, type EntityValidationV2ResultError as ak, type EntityValidationV2ResultSuccess as al, type EntityViewDisabled as am, type ErrorObject as an, type ExportJobId as ao, type FieldsParam as ap, type FileAttribute as aq, type FuzzyConfig as ar, type GenerateEntityTableAIFiltersRequest as as, type GenerateEntityTableAIFiltersResponse as at, GetRelatedEntitiesCount as au, type GetRelationsResp as av, type GetRelationsRespWithPagination as aw, type GraphDefinition as ax, type GraphEdge as ay, type GraphNode as az, type PathsDictionary as b, type PartnerStatusAttribute as b0, type PaymentAttribute as b1, type PaymentMethodRelationAttribute as b2, type PhoneAttribute as b3, type PortalAccessAttribute as b4, type PriceComponentAttribute as b5, type PurposeAttribute as b6, type RedirectEntityView as b7, type RelationAttribute as b8, type RelationEntity as b9, type TaxonomyBulkJobTriggerResponse as bA, type TaxonomyClassification as bB, type TaxonomyLocationId as bC, type TaxonomySearchIncludeArchivedParam as bD, type TaxonomySlug as bE, type TextAttribute as bF, type UserRelationAttribute as bG, type WipeJob as bH, type WipeJobConflictError as bI, type RelationItem as ba, type RepeatableAttribute as bb, type SavedView as bc, type SavedViewId as bd, type SavedViewItem as be, type SavedViewPartial as bf, type ScalarConditionDefinition as bg, type SchemaHead as bh, type SchemaId as bi, type SchemaVersionConflictError as bj, type SearchFilter as bk, type SearchFilterValue as bl, type SearchMappings as bm, type SelectAttribute as bn, type SelectConditionDefinition as bo, type SequenceAttribute as bp, type SettingFlag as bq, type StatusAttribute as br, type SummaryAttribute as bs, type SummaryField as bt, type TableAttribute as bu, type TagsAttribute as bv, type Taxonomy as bw, type TaxonomyBulkJob as bx, type TaxonomyBulkJobActionType as by, type TaxonomyBulkJobStatus as bz, type Activity as c, type ActivityCallerContext as d, type ActivityId as e, type ActivityItem as f, type ActivityType as g, type AddressAttribute as h, type AddressRelationAttribute as i, type AdjustInstallmentCapabilityConfig as j, type AttributeWithCompositeID as k, type AutomationAttribute as l, type BaseAttribute as m, type BaseConditionDefinition as n, type BaseEntity as o, type BlueprintEntityId as p, type BooleanAttribute as q, type Changeset as r, type ChangesetCreator as s, type ChangesetMap as t, type ClassificationId as u, type ClassificationIdOrPattern as v, type ClassificationSlug as w, type ClassificationsUpdate as x, type ComputedAttribute as y, type ConditionDefinition as z };