@vrplatform/api 1.3.1-stage.6380 → 1.3.1-stage.6384

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.
@@ -997,7 +997,7 @@ export interface paths {
997
997
  get?: never;
998
998
  put?: never;
999
999
  /**
1000
- * @description Queue a CSV import after permission checks. Reviewed imports must match the preview's upload, resource, mapping, and source hash. Bank-record previews become stale when the account start date changes.
1000
+ * @description Import a fixed-template CSV through a connection.
1001
1001
  *
1002
1002
  * Required scope: integrations:import
1003
1003
  */
@@ -1008,132 +1008,6 @@ export interface paths {
1008
1008
  patch?: never;
1009
1009
  trace?: never;
1010
1010
  };
1011
- "/connections/{id}/csv-import/preview": {
1012
- parameters: {
1013
- query?: never;
1014
- header?: never;
1015
- path?: never;
1016
- cookie?: never;
1017
- };
1018
- get?: never;
1019
- put?: never;
1020
- /**
1021
- * @description Start a CSV preview after checking the resource's write permission. Bank records require a team-scoped bank account; rows before its start date are system exclusions.
1022
- *
1023
- * Required scope: integrations:import
1024
- */
1025
- post: operations["postConnectionsByIdCsvImportPreview"];
1026
- delete?: never;
1027
- options?: never;
1028
- head?: never;
1029
- patch?: never;
1030
- trace?: never;
1031
- };
1032
- "/connections/{id}/csv-import/preview/{previewId}": {
1033
- parameters: {
1034
- query?: never;
1035
- header?: never;
1036
- path?: never;
1037
- cookie?: never;
1038
- };
1039
- /**
1040
- * @description Get a validated resource-discriminated CSV preview summary. Full logical records are available through the paginated records endpoint.
1041
- *
1042
- * Required scope: integrations:import
1043
- */
1044
- get: operations["getConnectionsByIdCsvImportPreviewByPreviewId"];
1045
- put?: never;
1046
- post?: never;
1047
- delete?: never;
1048
- options?: never;
1049
- head?: never;
1050
- patch?: never;
1051
- trace?: never;
1052
- };
1053
- "/connections/{id}/csv-import/preview/{previewId}/records": {
1054
- parameters: {
1055
- query?: never;
1056
- header?: never;
1057
- path?: never;
1058
- cookie?: never;
1059
- };
1060
- /**
1061
- * @description Get a bounded page of logical records from a completed CSV preview. The opaque cursor is bound to the preview, filter, and page size.
1062
- *
1063
- * Required scope: integrations:import
1064
- */
1065
- get: operations["getConnectionsByIdCsvImportPreviewByPreviewIdRecords"];
1066
- put?: never;
1067
- post?: never;
1068
- delete?: never;
1069
- options?: never;
1070
- head?: never;
1071
- patch?: never;
1072
- trace?: never;
1073
- };
1074
- "/connections/{id}/csv-import/uploads": {
1075
- parameters: {
1076
- query?: never;
1077
- header?: never;
1078
- path?: never;
1079
- cookie?: never;
1080
- };
1081
- get?: never;
1082
- put?: never;
1083
- /**
1084
- * @description Create a 24-hour Connection-scoped upload for one CSV up to 100,000,000 bytes. Send the unchanged file once to uploadUrl with Content-Type text/csv and Content-Length. Completed retries are idempotent.
1085
- *
1086
- * Required scope: integrations:import
1087
- */
1088
- post: operations["postConnectionsByIdCsvImportUploads"];
1089
- delete?: never;
1090
- options?: never;
1091
- head?: never;
1092
- patch?: never;
1093
- trace?: never;
1094
- };
1095
- "/connections/{id}/csv-import/uploads/{uploadRef}": {
1096
- parameters: {
1097
- query?: never;
1098
- header?: never;
1099
- path?: never;
1100
- cookie?: never;
1101
- };
1102
- get?: never;
1103
- /**
1104
- * @description Upload the complete raw CSV once to regional storage. Content-Type must be text/csv (parameters allowed). Content-Length is required, and the stored byte size must match fileSize. A completed retry does not overwrite the stored object.
1105
- *
1106
- * Required scope: integrations:import
1107
- */
1108
- put: operations["putConnectionsByIdCsvImportUploadsByUploadRef"];
1109
- post?: never;
1110
- delete?: never;
1111
- options?: never;
1112
- head?: never;
1113
- patch?: never;
1114
- trace?: never;
1115
- };
1116
- "/connections/{id}/csv-import/{syncId}": {
1117
- parameters: {
1118
- query?: never;
1119
- header?: never;
1120
- path?: never;
1121
- cookie?: never;
1122
- };
1123
- /**
1124
- * @description Get an asynchronous CSV import result
1125
- *
1126
- * Required scope: integrations:import
1127
- */
1128
- get: operations["getConnectionsByIdCsvImportBySyncId"];
1129
- put?: never;
1130
- post?: never;
1131
- delete?: never;
1132
- options?: never;
1133
- head?: never;
1134
- patch?: never;
1135
- trace?: never;
1136
- };
1137
1011
  "/connections/{id}/sync": {
1138
1012
  parameters: {
1139
1013
  query?: never;
@@ -26062,360 +25936,10 @@ export interface operations {
26062
25936
  fileData?: string;
26063
25937
  fileUri?: string;
26064
25938
  fileName?: string;
26065
- uploadRef?: string;
26066
- /** Format: uuid */
26067
- accountId?: string;
26068
- /** Format: uuid */
26069
- previewId?: string;
26070
- /** @enum {string} */
26071
- resource?: "bankRecords" | "owners" | "expenses" | "vendors" | "deposits";
26072
- uniqueRef?: string;
25939
+ uniqueRef: string;
26073
25940
  params?: {
26074
25941
  [key: string]: unknown;
26075
25942
  };
26076
- mapping?: {
26077
- /** @constant */
26078
- resource?: "bankRecords";
26079
- /** @constant */
26080
- version: 1;
26081
- /** @enum {string} */
26082
- delimiter: "," | ";" | "\t" | "|";
26083
- headerRow: number;
26084
- date: {
26085
- source?: string | null;
26086
- format?: ("yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy") | null;
26087
- };
26088
- description: {
26089
- sources: string[];
26090
- /** @constant */
26091
- operation: "join";
26092
- };
26093
- amount: {
26094
- /** @enum {string} */
26095
- mode: "signed" | "debitCredit";
26096
- source?: string | null;
26097
- debit?: string | null;
26098
- credit?: string | null;
26099
- /** @constant */
26100
- debitSign: -1;
26101
- /** @constant */
26102
- creditSign: 1;
26103
- };
26104
- excludedRows: number[];
26105
- } | {
26106
- /** @constant */
26107
- resource: "owners";
26108
- /** @constant */
26109
- version: 1;
26110
- /** @enum {string} */
26111
- delimiter: "," | ";" | "\t" | "|";
26112
- headerRow: number;
26113
- excludedRows: number[];
26114
- fields: {
26115
- listing: {
26116
- source?: string | null;
26117
- overrides: {
26118
- [key: string]: string;
26119
- };
26120
- };
26121
- ownerKind: {
26122
- source?: string | null;
26123
- /** @enum {string} */
26124
- constant?: "individual" | "company";
26125
- values: {
26126
- [key: string]: "individual" | "company";
26127
- };
26128
- };
26129
- firstName: {
26130
- source?: string | null;
26131
- };
26132
- lastName: {
26133
- source?: string | null;
26134
- };
26135
- companyName: {
26136
- source?: string | null;
26137
- };
26138
- companyType: {
26139
- source?: string | null;
26140
- values: {
26141
- [key: string]: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
26142
- };
26143
- };
26144
- ownerReference: {
26145
- source?: string | null;
26146
- overrides: {
26147
- [key: string]: string;
26148
- };
26149
- };
26150
- email: {
26151
- source?: string | null;
26152
- };
26153
- phone: {
26154
- source?: string | null;
26155
- };
26156
- taxIdentifier: {
26157
- source?: string | null;
26158
- };
26159
- address: {
26160
- source?: string | null;
26161
- };
26162
- unit: {
26163
- source?: string | null;
26164
- };
26165
- city: {
26166
- source?: string | null;
26167
- };
26168
- state: {
26169
- source?: string | null;
26170
- };
26171
- postalCode: {
26172
- source?: string | null;
26173
- };
26174
- country: {
26175
- source?: string | null;
26176
- };
26177
- payoutAccount: {
26178
- source?: string | null;
26179
- overrides: {
26180
- [key: string]: string;
26181
- };
26182
- };
26183
- };
26184
- } | {
26185
- /** @constant */
26186
- resource: "expenses";
26187
- /** @constant */
26188
- version: 1;
26189
- /** @enum {string} */
26190
- delimiter: "," | ";" | "\t" | "|";
26191
- headerRow: number;
26192
- excludedRows: number[];
26193
- fields: {
26194
- billReference: {
26195
- source?: string | null;
26196
- };
26197
- issueDate: {
26198
- source?: string | null;
26199
- /** @enum {string} */
26200
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
26201
- };
26202
- vendor: {
26203
- source?: string | null;
26204
- overrides: {
26205
- [key: string]: string;
26206
- };
26207
- };
26208
- status: {
26209
- source?: string | null;
26210
- /** @enum {string} */
26211
- constant?: "paid" | "unpaid";
26212
- values: {
26213
- [key: string]: "paid" | "unpaid";
26214
- };
26215
- };
26216
- paymentDate: {
26217
- source?: string | null;
26218
- /** @enum {string} */
26219
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
26220
- };
26221
- bankAccount: {
26222
- source?: string | null;
26223
- overrides: {
26224
- [key: string]: string;
26225
- };
26226
- };
26227
- currency: {
26228
- source?: string | null;
26229
- };
26230
- description: {
26231
- source?: string | null;
26232
- };
26233
- lineDescription: {
26234
- source?: string | null;
26235
- };
26236
- expenseAccount: {
26237
- source?: string | null;
26238
- overrides: {
26239
- [key: string]: string;
26240
- };
26241
- };
26242
- appliedAmount: {
26243
- source?: string | null;
26244
- };
26245
- reservation: {
26246
- source?: string | null;
26247
- overrides: {
26248
- [key: string]: string;
26249
- };
26250
- };
26251
- listing: {
26252
- source?: string | null;
26253
- overrides: {
26254
- [key: string]: string;
26255
- };
26256
- };
26257
- billToOwner: {
26258
- source?: string | null;
26259
- constant?: boolean;
26260
- values: {
26261
- [key: string]: boolean;
26262
- };
26263
- };
26264
- markup: {
26265
- source?: string | null;
26266
- };
26267
- markupTax: {
26268
- source?: string | null;
26269
- overrides: {
26270
- [key: string]: string;
26271
- };
26272
- };
26273
- };
26274
- } | {
26275
- /** @constant */
26276
- resource: "vendors";
26277
- /** @constant */
26278
- version: 1;
26279
- /** @enum {string} */
26280
- delimiter: "," | ";" | "\t" | "|";
26281
- headerRow: number;
26282
- excludedRows: number[];
26283
- fields: {
26284
- vendorKind: {
26285
- source?: string | null;
26286
- /** @enum {string} */
26287
- constant?: "individual" | "company";
26288
- values: {
26289
- [key: string]: "individual" | "company";
26290
- };
26291
- };
26292
- firstName: {
26293
- source?: string | null;
26294
- };
26295
- lastName: {
26296
- source?: string | null;
26297
- };
26298
- companyName: {
26299
- source?: string | null;
26300
- };
26301
- companyType: {
26302
- source?: string | null;
26303
- values: {
26304
- [key: string]: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
26305
- };
26306
- };
26307
- vendorReference: {
26308
- source?: string | null;
26309
- overrides: {
26310
- [key: string]: string;
26311
- };
26312
- };
26313
- email: {
26314
- source?: string | null;
26315
- };
26316
- phone: {
26317
- source?: string | null;
26318
- };
26319
- taxIdentifier: {
26320
- source?: string | null;
26321
- };
26322
- address: {
26323
- source?: string | null;
26324
- };
26325
- unit: {
26326
- source?: string | null;
26327
- };
26328
- city: {
26329
- source?: string | null;
26330
- };
26331
- state: {
26332
- source?: string | null;
26333
- };
26334
- postalCode: {
26335
- source?: string | null;
26336
- };
26337
- country: {
26338
- source?: string | null;
26339
- };
26340
- };
26341
- } | {
26342
- /** @constant */
26343
- resource: "deposits";
26344
- /** @constant */
26345
- version: 1;
26346
- /** @enum {string} */
26347
- delimiter: "," | ";" | "\t" | "|";
26348
- headerRow: number;
26349
- excludedRows: number[];
26350
- fields: {
26351
- reference: {
26352
- source?: string | null;
26353
- };
26354
- date: {
26355
- source?: string | null;
26356
- /** @enum {string} */
26357
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
26358
- };
26359
- bankAccount: {
26360
- source?: string | null;
26361
- overrides: {
26362
- [key: string]: string;
26363
- };
26364
- };
26365
- description: {
26366
- source?: string | null;
26367
- };
26368
- currency: {
26369
- source?: string | null;
26370
- };
26371
- reservation: {
26372
- source?: string | null;
26373
- overrides: {
26374
- [key: string]: string;
26375
- };
26376
- };
26377
- contact: {
26378
- source?: string | null;
26379
- overrides: {
26380
- [key: string]: string;
26381
- };
26382
- };
26383
- listing: {
26384
- source?: string | null;
26385
- overrides: {
26386
- [key: string]: string;
26387
- };
26388
- };
26389
- account: {
26390
- source?: string | null;
26391
- overrides: {
26392
- [key: string]: string;
26393
- };
26394
- };
26395
- lineDescription: {
26396
- source?: string | null;
26397
- };
26398
- appliedAmount: {
26399
- source?: string | null;
26400
- };
26401
- merchantFee: {
26402
- source?: string | null;
26403
- };
26404
- channelFee: {
26405
- source?: string | null;
26406
- };
26407
- reserve: {
26408
- source?: string | null;
26409
- };
26410
- coHostPayout: {
26411
- source?: string | null;
26412
- };
26413
- vat: {
26414
- source?: string | null;
26415
- };
26416
- };
26417
- };
26418
- sourceHash?: string;
26419
25943
  };
26420
25944
  };
26421
25945
  };
@@ -26427,7 +25951,7 @@ export interface operations {
26427
25951
  };
26428
25952
  content: {
26429
25953
  "application/json": {
26430
- data: ({
25954
+ data: {
26431
25955
  syncId: string;
26432
25956
  /** @enum {string} */
26433
25957
  status: "completed";
@@ -26440,3037 +25964,6 @@ export interface operations {
26440
25964
  rowNumber: number;
26441
25965
  message: string;
26442
25966
  }[];
26443
- }) | {
26444
- syncId: string;
26445
- /** @enum {string} */
26446
- status: "queued";
26447
- };
26448
- };
26449
- };
26450
- };
26451
- /** @description Bad request */
26452
- 400: {
26453
- headers: {
26454
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26455
- "Retry-After"?: number;
26456
- [name: string]: unknown;
26457
- };
26458
- content: {
26459
- "application/json": {
26460
- code: string;
26461
- message: string;
26462
- links?: {
26463
- docs: string;
26464
- schema: string;
26465
- };
26466
- issues?: {
26467
- message: string;
26468
- path?: (string | number)[];
26469
- schema?: string;
26470
- }[];
26471
- retryable?: boolean;
26472
- context?: unknown;
26473
- };
26474
- };
26475
- };
26476
- /** @description Unauthorized */
26477
- 401: {
26478
- headers: {
26479
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26480
- "Retry-After"?: number;
26481
- [name: string]: unknown;
26482
- };
26483
- content: {
26484
- "application/json": {
26485
- code: string;
26486
- message: string;
26487
- links?: {
26488
- docs: string;
26489
- schema: string;
26490
- };
26491
- issues?: {
26492
- message: string;
26493
- path?: (string | number)[];
26494
- schema?: string;
26495
- }[];
26496
- retryable?: boolean;
26497
- context?: unknown;
26498
- };
26499
- };
26500
- };
26501
- /** @description Forbidden */
26502
- 403: {
26503
- headers: {
26504
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26505
- "Retry-After"?: number;
26506
- [name: string]: unknown;
26507
- };
26508
- content: {
26509
- "application/json": {
26510
- code: string;
26511
- message: string;
26512
- links?: {
26513
- docs: string;
26514
- schema: string;
26515
- };
26516
- issues?: {
26517
- message: string;
26518
- path?: (string | number)[];
26519
- schema?: string;
26520
- }[];
26521
- retryable?: boolean;
26522
- context?: unknown;
26523
- };
26524
- };
26525
- };
26526
- /** @description Not found */
26527
- 404: {
26528
- headers: {
26529
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26530
- "Retry-After"?: number;
26531
- [name: string]: unknown;
26532
- };
26533
- content: {
26534
- "application/json": {
26535
- code: string;
26536
- message: string;
26537
- links?: {
26538
- docs: string;
26539
- schema: string;
26540
- };
26541
- issues?: {
26542
- message: string;
26543
- path?: (string | number)[];
26544
- schema?: string;
26545
- }[];
26546
- retryable?: boolean;
26547
- context?: unknown;
26548
- };
26549
- };
26550
- };
26551
- /** @description Conflict */
26552
- 409: {
26553
- headers: {
26554
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26555
- "Retry-After"?: number;
26556
- [name: string]: unknown;
26557
- };
26558
- content: {
26559
- "application/json": {
26560
- code: string;
26561
- message: string;
26562
- links?: {
26563
- docs: string;
26564
- schema: string;
26565
- };
26566
- issues?: {
26567
- message: string;
26568
- path?: (string | number)[];
26569
- schema?: string;
26570
- }[];
26571
- retryable?: boolean;
26572
- context?: unknown;
26573
- };
26574
- };
26575
- };
26576
- /** @description Gone */
26577
- 410: {
26578
- headers: {
26579
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26580
- "Retry-After"?: number;
26581
- [name: string]: unknown;
26582
- };
26583
- content: {
26584
- "application/json": {
26585
- code: string;
26586
- message: string;
26587
- links?: {
26588
- docs: string;
26589
- schema: string;
26590
- };
26591
- issues?: {
26592
- message: string;
26593
- path?: (string | number)[];
26594
- schema?: string;
26595
- }[];
26596
- retryable?: boolean;
26597
- context?: unknown;
26598
- };
26599
- };
26600
- };
26601
- /** @description Unprocessable content */
26602
- 422: {
26603
- headers: {
26604
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26605
- "Retry-After"?: number;
26606
- [name: string]: unknown;
26607
- };
26608
- content: {
26609
- "application/json": {
26610
- code: string;
26611
- message: string;
26612
- links?: {
26613
- docs: string;
26614
- schema: string;
26615
- };
26616
- issues?: {
26617
- message: string;
26618
- path?: (string | number)[];
26619
- schema?: string;
26620
- }[];
26621
- retryable?: boolean;
26622
- context?: unknown;
26623
- };
26624
- };
26625
- };
26626
- /** @description Internal server error */
26627
- 500: {
26628
- headers: {
26629
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26630
- "Retry-After"?: number;
26631
- [name: string]: unknown;
26632
- };
26633
- content: {
26634
- "application/json": {
26635
- code: string;
26636
- message: string;
26637
- links?: {
26638
- docs: string;
26639
- schema: string;
26640
- };
26641
- issues?: {
26642
- message: string;
26643
- path?: (string | number)[];
26644
- schema?: string;
26645
- }[];
26646
- retryable?: boolean;
26647
- context?: unknown;
26648
- };
26649
- };
26650
- };
26651
- /** @description Service unavailable */
26652
- 503: {
26653
- headers: {
26654
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
26655
- "Retry-After"?: number;
26656
- [name: string]: unknown;
26657
- };
26658
- content: {
26659
- "application/json": {
26660
- code: string;
26661
- message: string;
26662
- links?: {
26663
- docs: string;
26664
- schema: string;
26665
- };
26666
- issues?: {
26667
- message: string;
26668
- path?: (string | number)[];
26669
- schema?: string;
26670
- }[];
26671
- retryable?: boolean;
26672
- context?: unknown;
26673
- };
26674
- };
26675
- };
26676
- };
26677
- };
26678
- postConnectionsByIdCsvImportPreview: {
26679
- parameters: {
26680
- query?: never;
26681
- header?: never;
26682
- path: {
26683
- id: string;
26684
- };
26685
- cookie?: never;
26686
- };
26687
- requestBody?: {
26688
- content: {
26689
- "application/json": {
26690
- /** @enum {string} */
26691
- resource?: "bankRecords" | "owners" | "expenses" | "vendors" | "deposits";
26692
- /** Format: uuid */
26693
- accountId?: string;
26694
- uploadRef: string;
26695
- mapping?: {
26696
- /** @constant */
26697
- resource?: "bankRecords";
26698
- /** @constant */
26699
- version: 1;
26700
- /** @enum {string} */
26701
- delimiter: "," | ";" | "\t" | "|";
26702
- headerRow: number;
26703
- date: {
26704
- source?: string | null;
26705
- format?: ("yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy") | null;
26706
- };
26707
- description: {
26708
- sources: string[];
26709
- /** @constant */
26710
- operation: "join";
26711
- };
26712
- amount: {
26713
- /** @enum {string} */
26714
- mode: "signed" | "debitCredit";
26715
- source?: string | null;
26716
- debit?: string | null;
26717
- credit?: string | null;
26718
- /** @constant */
26719
- debitSign: -1;
26720
- /** @constant */
26721
- creditSign: 1;
26722
- };
26723
- excludedRows: number[];
26724
- } | {
26725
- /** @constant */
26726
- resource: "owners";
26727
- /** @constant */
26728
- version: 1;
26729
- /** @enum {string} */
26730
- delimiter: "," | ";" | "\t" | "|";
26731
- headerRow: number;
26732
- excludedRows: number[];
26733
- fields: {
26734
- listing: {
26735
- source?: string | null;
26736
- overrides: {
26737
- [key: string]: string;
26738
- };
26739
- };
26740
- ownerKind: {
26741
- source?: string | null;
26742
- /** @enum {string} */
26743
- constant?: "individual" | "company";
26744
- values: {
26745
- [key: string]: "individual" | "company";
26746
- };
26747
- };
26748
- firstName: {
26749
- source?: string | null;
26750
- };
26751
- lastName: {
26752
- source?: string | null;
26753
- };
26754
- companyName: {
26755
- source?: string | null;
26756
- };
26757
- companyType: {
26758
- source?: string | null;
26759
- values: {
26760
- [key: string]: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
26761
- };
26762
- };
26763
- ownerReference: {
26764
- source?: string | null;
26765
- overrides: {
26766
- [key: string]: string;
26767
- };
26768
- };
26769
- email: {
26770
- source?: string | null;
26771
- };
26772
- phone: {
26773
- source?: string | null;
26774
- };
26775
- taxIdentifier: {
26776
- source?: string | null;
26777
- };
26778
- address: {
26779
- source?: string | null;
26780
- };
26781
- unit: {
26782
- source?: string | null;
26783
- };
26784
- city: {
26785
- source?: string | null;
26786
- };
26787
- state: {
26788
- source?: string | null;
26789
- };
26790
- postalCode: {
26791
- source?: string | null;
26792
- };
26793
- country: {
26794
- source?: string | null;
26795
- };
26796
- payoutAccount: {
26797
- source?: string | null;
26798
- overrides: {
26799
- [key: string]: string;
26800
- };
26801
- };
26802
- };
26803
- } | {
26804
- /** @constant */
26805
- resource: "expenses";
26806
- /** @constant */
26807
- version: 1;
26808
- /** @enum {string} */
26809
- delimiter: "," | ";" | "\t" | "|";
26810
- headerRow: number;
26811
- excludedRows: number[];
26812
- fields: {
26813
- billReference: {
26814
- source?: string | null;
26815
- };
26816
- issueDate: {
26817
- source?: string | null;
26818
- /** @enum {string} */
26819
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
26820
- };
26821
- vendor: {
26822
- source?: string | null;
26823
- overrides: {
26824
- [key: string]: string;
26825
- };
26826
- };
26827
- status: {
26828
- source?: string | null;
26829
- /** @enum {string} */
26830
- constant?: "paid" | "unpaid";
26831
- values: {
26832
- [key: string]: "paid" | "unpaid";
26833
- };
26834
- };
26835
- paymentDate: {
26836
- source?: string | null;
26837
- /** @enum {string} */
26838
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
26839
- };
26840
- bankAccount: {
26841
- source?: string | null;
26842
- overrides: {
26843
- [key: string]: string;
26844
- };
26845
- };
26846
- currency: {
26847
- source?: string | null;
26848
- };
26849
- description: {
26850
- source?: string | null;
26851
- };
26852
- lineDescription: {
26853
- source?: string | null;
26854
- };
26855
- expenseAccount: {
26856
- source?: string | null;
26857
- overrides: {
26858
- [key: string]: string;
26859
- };
26860
- };
26861
- appliedAmount: {
26862
- source?: string | null;
26863
- };
26864
- reservation: {
26865
- source?: string | null;
26866
- overrides: {
26867
- [key: string]: string;
26868
- };
26869
- };
26870
- listing: {
26871
- source?: string | null;
26872
- overrides: {
26873
- [key: string]: string;
26874
- };
26875
- };
26876
- billToOwner: {
26877
- source?: string | null;
26878
- constant?: boolean;
26879
- values: {
26880
- [key: string]: boolean;
26881
- };
26882
- };
26883
- markup: {
26884
- source?: string | null;
26885
- };
26886
- markupTax: {
26887
- source?: string | null;
26888
- overrides: {
26889
- [key: string]: string;
26890
- };
26891
- };
26892
- };
26893
- } | {
26894
- /** @constant */
26895
- resource: "vendors";
26896
- /** @constant */
26897
- version: 1;
26898
- /** @enum {string} */
26899
- delimiter: "," | ";" | "\t" | "|";
26900
- headerRow: number;
26901
- excludedRows: number[];
26902
- fields: {
26903
- vendorKind: {
26904
- source?: string | null;
26905
- /** @enum {string} */
26906
- constant?: "individual" | "company";
26907
- values: {
26908
- [key: string]: "individual" | "company";
26909
- };
26910
- };
26911
- firstName: {
26912
- source?: string | null;
26913
- };
26914
- lastName: {
26915
- source?: string | null;
26916
- };
26917
- companyName: {
26918
- source?: string | null;
26919
- };
26920
- companyType: {
26921
- source?: string | null;
26922
- values: {
26923
- [key: string]: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
26924
- };
26925
- };
26926
- vendorReference: {
26927
- source?: string | null;
26928
- overrides: {
26929
- [key: string]: string;
26930
- };
26931
- };
26932
- email: {
26933
- source?: string | null;
26934
- };
26935
- phone: {
26936
- source?: string | null;
26937
- };
26938
- taxIdentifier: {
26939
- source?: string | null;
26940
- };
26941
- address: {
26942
- source?: string | null;
26943
- };
26944
- unit: {
26945
- source?: string | null;
26946
- };
26947
- city: {
26948
- source?: string | null;
26949
- };
26950
- state: {
26951
- source?: string | null;
26952
- };
26953
- postalCode: {
26954
- source?: string | null;
26955
- };
26956
- country: {
26957
- source?: string | null;
26958
- };
26959
- };
26960
- } | {
26961
- /** @constant */
26962
- resource: "deposits";
26963
- /** @constant */
26964
- version: 1;
26965
- /** @enum {string} */
26966
- delimiter: "," | ";" | "\t" | "|";
26967
- headerRow: number;
26968
- excludedRows: number[];
26969
- fields: {
26970
- reference: {
26971
- source?: string | null;
26972
- };
26973
- date: {
26974
- source?: string | null;
26975
- /** @enum {string} */
26976
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
26977
- };
26978
- bankAccount: {
26979
- source?: string | null;
26980
- overrides: {
26981
- [key: string]: string;
26982
- };
26983
- };
26984
- description: {
26985
- source?: string | null;
26986
- };
26987
- currency: {
26988
- source?: string | null;
26989
- };
26990
- reservation: {
26991
- source?: string | null;
26992
- overrides: {
26993
- [key: string]: string;
26994
- };
26995
- };
26996
- contact: {
26997
- source?: string | null;
26998
- overrides: {
26999
- [key: string]: string;
27000
- };
27001
- };
27002
- listing: {
27003
- source?: string | null;
27004
- overrides: {
27005
- [key: string]: string;
27006
- };
27007
- };
27008
- account: {
27009
- source?: string | null;
27010
- overrides: {
27011
- [key: string]: string;
27012
- };
27013
- };
27014
- lineDescription: {
27015
- source?: string | null;
27016
- };
27017
- appliedAmount: {
27018
- source?: string | null;
27019
- };
27020
- merchantFee: {
27021
- source?: string | null;
27022
- };
27023
- channelFee: {
27024
- source?: string | null;
27025
- };
27026
- reserve: {
27027
- source?: string | null;
27028
- };
27029
- coHostPayout: {
27030
- source?: string | null;
27031
- };
27032
- vat: {
27033
- source?: string | null;
27034
- };
27035
- };
27036
- };
27037
- };
27038
- };
27039
- };
27040
- responses: {
27041
- /** @description Successful response */
27042
- 200: {
27043
- headers: {
27044
- [name: string]: unknown;
27045
- };
27046
- content: {
27047
- "application/json": {
27048
- data: {
27049
- /** @constant */
27050
- status: "queued";
27051
- /** Format: uuid */
27052
- previewId: string;
27053
- /** Format: uuid */
27054
- syncId: string;
27055
- } | {
27056
- /** @constant */
27057
- status: "processing";
27058
- /** Format: uuid */
27059
- previewId: string;
27060
- /** Format: uuid */
27061
- syncId: string;
27062
- } | {
27063
- /** @constant */
27064
- status: "completed";
27065
- /** Format: uuid */
27066
- previewId: string;
27067
- /** Format: uuid */
27068
- syncId: string;
27069
- result: {
27070
- canImport: boolean;
27071
- columns: string[];
27072
- issues: {
27073
- code: string;
27074
- field?: string;
27075
- rowNumber: number;
27076
- message: string;
27077
- }[];
27078
- issueCounts: {
27079
- [key: string]: number;
27080
- };
27081
- logicalRecordCount: number;
27082
- resolutionCounts: {
27083
- matched: number;
27084
- unmatched: number;
27085
- ambiguous: number;
27086
- };
27087
- sourceHash: string;
27088
- /** @constant */
27089
- resource: "bankRecords";
27090
- mapping: {
27091
- /** @constant */
27092
- resource?: "bankRecords";
27093
- /** @constant */
27094
- version: 1;
27095
- /** @enum {string} */
27096
- delimiter: "," | ";" | "\t" | "|";
27097
- headerRow: number;
27098
- date: {
27099
- source?: string | null;
27100
- format?: ("yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy") | null;
27101
- };
27102
- description: {
27103
- sources: string[];
27104
- /** @constant */
27105
- operation: "join";
27106
- };
27107
- amount: {
27108
- /** @enum {string} */
27109
- mode: "signed" | "debitCredit";
27110
- source?: string | null;
27111
- debit?: string | null;
27112
- credit?: string | null;
27113
- /** @constant */
27114
- debitSign: -1;
27115
- /** @constant */
27116
- creditSign: 1;
27117
- };
27118
- excludedRows: number[];
27119
- };
27120
- totals: {
27121
- rows: number;
27122
- valid: number;
27123
- invalid: number;
27124
- excluded: number;
27125
- moneyIn: number;
27126
- moneyOut: number;
27127
- net: number;
27128
- };
27129
- } | {
27130
- canImport: boolean;
27131
- columns: string[];
27132
- issues: {
27133
- code: string;
27134
- field?: string;
27135
- rowNumber: number;
27136
- message: string;
27137
- }[];
27138
- issueCounts: {
27139
- [key: string]: number;
27140
- };
27141
- logicalRecordCount: number;
27142
- resolutionCounts: {
27143
- matched: number;
27144
- unmatched: number;
27145
- ambiguous: number;
27146
- };
27147
- sourceHash: string;
27148
- /** @constant */
27149
- resource: "owners";
27150
- mapping: {
27151
- /** @constant */
27152
- resource: "owners";
27153
- /** @constant */
27154
- version: 1;
27155
- /** @enum {string} */
27156
- delimiter: "," | ";" | "\t" | "|";
27157
- headerRow: number;
27158
- excludedRows: number[];
27159
- fields: {
27160
- listing: {
27161
- source?: string | null;
27162
- overrides: {
27163
- [key: string]: string;
27164
- };
27165
- };
27166
- ownerKind: {
27167
- source?: string | null;
27168
- /** @enum {string} */
27169
- constant?: "individual" | "company";
27170
- values: {
27171
- [key: string]: "individual" | "company";
27172
- };
27173
- };
27174
- firstName: {
27175
- source?: string | null;
27176
- };
27177
- lastName: {
27178
- source?: string | null;
27179
- };
27180
- companyName: {
27181
- source?: string | null;
27182
- };
27183
- companyType: {
27184
- source?: string | null;
27185
- values: {
27186
- [key: string]: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
27187
- };
27188
- };
27189
- ownerReference: {
27190
- source?: string | null;
27191
- overrides: {
27192
- [key: string]: string;
27193
- };
27194
- };
27195
- email: {
27196
- source?: string | null;
27197
- };
27198
- phone: {
27199
- source?: string | null;
27200
- };
27201
- taxIdentifier: {
27202
- source?: string | null;
27203
- };
27204
- address: {
27205
- source?: string | null;
27206
- };
27207
- unit: {
27208
- source?: string | null;
27209
- };
27210
- city: {
27211
- source?: string | null;
27212
- };
27213
- state: {
27214
- source?: string | null;
27215
- };
27216
- postalCode: {
27217
- source?: string | null;
27218
- };
27219
- country: {
27220
- source?: string | null;
27221
- };
27222
- payoutAccount: {
27223
- source?: string | null;
27224
- overrides: {
27225
- [key: string]: string;
27226
- };
27227
- };
27228
- };
27229
- };
27230
- totals: {
27231
- rows: number;
27232
- valid: number;
27233
- invalid: number;
27234
- excluded: number;
27235
- owners: number;
27236
- listings: number;
27237
- create: number;
27238
- update: number;
27239
- conflicts: number;
27240
- };
27241
- } | {
27242
- canImport: boolean;
27243
- columns: string[];
27244
- issues: {
27245
- code: string;
27246
- field?: string;
27247
- rowNumber: number;
27248
- message: string;
27249
- }[];
27250
- issueCounts: {
27251
- [key: string]: number;
27252
- };
27253
- logicalRecordCount: number;
27254
- resolutionCounts: {
27255
- matched: number;
27256
- unmatched: number;
27257
- ambiguous: number;
27258
- };
27259
- sourceHash: string;
27260
- /** @constant */
27261
- resource: "expenses";
27262
- mapping: {
27263
- /** @constant */
27264
- resource: "expenses";
27265
- /** @constant */
27266
- version: 1;
27267
- /** @enum {string} */
27268
- delimiter: "," | ";" | "\t" | "|";
27269
- headerRow: number;
27270
- excludedRows: number[];
27271
- fields: {
27272
- billReference: {
27273
- source?: string | null;
27274
- };
27275
- issueDate: {
27276
- source?: string | null;
27277
- /** @enum {string} */
27278
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
27279
- };
27280
- vendor: {
27281
- source?: string | null;
27282
- overrides: {
27283
- [key: string]: string;
27284
- };
27285
- };
27286
- status: {
27287
- source?: string | null;
27288
- /** @enum {string} */
27289
- constant?: "paid" | "unpaid";
27290
- values: {
27291
- [key: string]: "paid" | "unpaid";
27292
- };
27293
- };
27294
- paymentDate: {
27295
- source?: string | null;
27296
- /** @enum {string} */
27297
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
27298
- };
27299
- bankAccount: {
27300
- source?: string | null;
27301
- overrides: {
27302
- [key: string]: string;
27303
- };
27304
- };
27305
- currency: {
27306
- source?: string | null;
27307
- };
27308
- description: {
27309
- source?: string | null;
27310
- };
27311
- lineDescription: {
27312
- source?: string | null;
27313
- };
27314
- expenseAccount: {
27315
- source?: string | null;
27316
- overrides: {
27317
- [key: string]: string;
27318
- };
27319
- };
27320
- appliedAmount: {
27321
- source?: string | null;
27322
- };
27323
- reservation: {
27324
- source?: string | null;
27325
- overrides: {
27326
- [key: string]: string;
27327
- };
27328
- };
27329
- listing: {
27330
- source?: string | null;
27331
- overrides: {
27332
- [key: string]: string;
27333
- };
27334
- };
27335
- billToOwner: {
27336
- source?: string | null;
27337
- constant?: boolean;
27338
- values: {
27339
- [key: string]: boolean;
27340
- };
27341
- };
27342
- markup: {
27343
- source?: string | null;
27344
- };
27345
- markupTax: {
27346
- source?: string | null;
27347
- overrides: {
27348
- [key: string]: string;
27349
- };
27350
- };
27351
- };
27352
- };
27353
- totals: {
27354
- rows: number;
27355
- expenses: number;
27356
- valid: number;
27357
- invalid: number;
27358
- excluded: number;
27359
- applied: number;
27360
- markup: number;
27361
- byCurrency: {
27362
- [key: string]: {
27363
- applied: number;
27364
- markup: number;
27365
- };
27366
- };
27367
- };
27368
- } | {
27369
- canImport: boolean;
27370
- columns: string[];
27371
- issues: {
27372
- code: string;
27373
- field?: string;
27374
- rowNumber: number;
27375
- message: string;
27376
- }[];
27377
- issueCounts: {
27378
- [key: string]: number;
27379
- };
27380
- logicalRecordCount: number;
27381
- resolutionCounts: {
27382
- matched: number;
27383
- unmatched: number;
27384
- ambiguous: number;
27385
- };
27386
- sourceHash: string;
27387
- /** @constant */
27388
- resource: "vendors";
27389
- mapping: {
27390
- /** @constant */
27391
- resource: "vendors";
27392
- /** @constant */
27393
- version: 1;
27394
- /** @enum {string} */
27395
- delimiter: "," | ";" | "\t" | "|";
27396
- headerRow: number;
27397
- excludedRows: number[];
27398
- fields: {
27399
- vendorKind: {
27400
- source?: string | null;
27401
- /** @enum {string} */
27402
- constant?: "individual" | "company";
27403
- values: {
27404
- [key: string]: "individual" | "company";
27405
- };
27406
- };
27407
- firstName: {
27408
- source?: string | null;
27409
- };
27410
- lastName: {
27411
- source?: string | null;
27412
- };
27413
- companyName: {
27414
- source?: string | null;
27415
- };
27416
- companyType: {
27417
- source?: string | null;
27418
- values: {
27419
- [key: string]: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
27420
- };
27421
- };
27422
- vendorReference: {
27423
- source?: string | null;
27424
- overrides: {
27425
- [key: string]: string;
27426
- };
27427
- };
27428
- email: {
27429
- source?: string | null;
27430
- };
27431
- phone: {
27432
- source?: string | null;
27433
- };
27434
- taxIdentifier: {
27435
- source?: string | null;
27436
- };
27437
- address: {
27438
- source?: string | null;
27439
- };
27440
- unit: {
27441
- source?: string | null;
27442
- };
27443
- city: {
27444
- source?: string | null;
27445
- };
27446
- state: {
27447
- source?: string | null;
27448
- };
27449
- postalCode: {
27450
- source?: string | null;
27451
- };
27452
- country: {
27453
- source?: string | null;
27454
- };
27455
- };
27456
- };
27457
- totals: {
27458
- rows: number;
27459
- valid: number;
27460
- invalid: number;
27461
- excluded: number;
27462
- create: number;
27463
- update: number;
27464
- duplicate: number;
27465
- ambiguous: number;
27466
- };
27467
- } | {
27468
- canImport: boolean;
27469
- columns: string[];
27470
- issues: {
27471
- code: string;
27472
- field?: string;
27473
- rowNumber: number;
27474
- message: string;
27475
- }[];
27476
- issueCounts: {
27477
- [key: string]: number;
27478
- };
27479
- logicalRecordCount: number;
27480
- resolutionCounts: {
27481
- matched: number;
27482
- unmatched: number;
27483
- ambiguous: number;
27484
- };
27485
- sourceHash: string;
27486
- /** @constant */
27487
- resource: "deposits";
27488
- mapping: {
27489
- /** @constant */
27490
- resource: "deposits";
27491
- /** @constant */
27492
- version: 1;
27493
- /** @enum {string} */
27494
- delimiter: "," | ";" | "\t" | "|";
27495
- headerRow: number;
27496
- excludedRows: number[];
27497
- fields: {
27498
- reference: {
27499
- source?: string | null;
27500
- };
27501
- date: {
27502
- source?: string | null;
27503
- /** @enum {string} */
27504
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
27505
- };
27506
- bankAccount: {
27507
- source?: string | null;
27508
- overrides: {
27509
- [key: string]: string;
27510
- };
27511
- };
27512
- description: {
27513
- source?: string | null;
27514
- };
27515
- currency: {
27516
- source?: string | null;
27517
- };
27518
- reservation: {
27519
- source?: string | null;
27520
- overrides: {
27521
- [key: string]: string;
27522
- };
27523
- };
27524
- contact: {
27525
- source?: string | null;
27526
- overrides: {
27527
- [key: string]: string;
27528
- };
27529
- };
27530
- listing: {
27531
- source?: string | null;
27532
- overrides: {
27533
- [key: string]: string;
27534
- };
27535
- };
27536
- account: {
27537
- source?: string | null;
27538
- overrides: {
27539
- [key: string]: string;
27540
- };
27541
- };
27542
- lineDescription: {
27543
- source?: string | null;
27544
- };
27545
- appliedAmount: {
27546
- source?: string | null;
27547
- };
27548
- merchantFee: {
27549
- source?: string | null;
27550
- };
27551
- channelFee: {
27552
- source?: string | null;
27553
- };
27554
- reserve: {
27555
- source?: string | null;
27556
- };
27557
- coHostPayout: {
27558
- source?: string | null;
27559
- };
27560
- vat: {
27561
- source?: string | null;
27562
- };
27563
- };
27564
- };
27565
- totals: {
27566
- rows: number;
27567
- deposits: number;
27568
- valid: number;
27569
- invalid: number;
27570
- excluded: number;
27571
- applied: number;
27572
- merchantFee: number;
27573
- channelFee: number;
27574
- reserve: number;
27575
- coHostPayout: number;
27576
- vat: number;
27577
- net: number;
27578
- byCurrency: {
27579
- [key: string]: {
27580
- applied: number;
27581
- merchantFee: number;
27582
- channelFee: number;
27583
- reserve: number;
27584
- coHostPayout: number;
27585
- vat: number;
27586
- net: number;
27587
- };
27588
- };
27589
- };
27590
- };
27591
- } | {
27592
- /** @constant */
27593
- status: "failed";
27594
- /** Format: uuid */
27595
- previewId: string;
27596
- /** Format: uuid */
27597
- syncId: string;
27598
- error: string;
27599
- };
27600
- };
27601
- };
27602
- };
27603
- /** @description Bad request */
27604
- 400: {
27605
- headers: {
27606
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27607
- "Retry-After"?: number;
27608
- [name: string]: unknown;
27609
- };
27610
- content: {
27611
- "application/json": {
27612
- code: string;
27613
- message: string;
27614
- links?: {
27615
- docs: string;
27616
- schema: string;
27617
- };
27618
- issues?: {
27619
- message: string;
27620
- path?: (string | number)[];
27621
- schema?: string;
27622
- }[];
27623
- retryable?: boolean;
27624
- context?: unknown;
27625
- };
27626
- };
27627
- };
27628
- /** @description Unauthorized */
27629
- 401: {
27630
- headers: {
27631
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27632
- "Retry-After"?: number;
27633
- [name: string]: unknown;
27634
- };
27635
- content: {
27636
- "application/json": {
27637
- code: string;
27638
- message: string;
27639
- links?: {
27640
- docs: string;
27641
- schema: string;
27642
- };
27643
- issues?: {
27644
- message: string;
27645
- path?: (string | number)[];
27646
- schema?: string;
27647
- }[];
27648
- retryable?: boolean;
27649
- context?: unknown;
27650
- };
27651
- };
27652
- };
27653
- /** @description Forbidden */
27654
- 403: {
27655
- headers: {
27656
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27657
- "Retry-After"?: number;
27658
- [name: string]: unknown;
27659
- };
27660
- content: {
27661
- "application/json": {
27662
- code: string;
27663
- message: string;
27664
- links?: {
27665
- docs: string;
27666
- schema: string;
27667
- };
27668
- issues?: {
27669
- message: string;
27670
- path?: (string | number)[];
27671
- schema?: string;
27672
- }[];
27673
- retryable?: boolean;
27674
- context?: unknown;
27675
- };
27676
- };
27677
- };
27678
- /** @description Not found */
27679
- 404: {
27680
- headers: {
27681
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27682
- "Retry-After"?: number;
27683
- [name: string]: unknown;
27684
- };
27685
- content: {
27686
- "application/json": {
27687
- code: string;
27688
- message: string;
27689
- links?: {
27690
- docs: string;
27691
- schema: string;
27692
- };
27693
- issues?: {
27694
- message: string;
27695
- path?: (string | number)[];
27696
- schema?: string;
27697
- }[];
27698
- retryable?: boolean;
27699
- context?: unknown;
27700
- };
27701
- };
27702
- };
27703
- /** @description Conflict */
27704
- 409: {
27705
- headers: {
27706
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27707
- "Retry-After"?: number;
27708
- [name: string]: unknown;
27709
- };
27710
- content: {
27711
- "application/json": {
27712
- code: string;
27713
- message: string;
27714
- links?: {
27715
- docs: string;
27716
- schema: string;
27717
- };
27718
- issues?: {
27719
- message: string;
27720
- path?: (string | number)[];
27721
- schema?: string;
27722
- }[];
27723
- retryable?: boolean;
27724
- context?: unknown;
27725
- };
27726
- };
27727
- };
27728
- /** @description Gone */
27729
- 410: {
27730
- headers: {
27731
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27732
- "Retry-After"?: number;
27733
- [name: string]: unknown;
27734
- };
27735
- content: {
27736
- "application/json": {
27737
- code: string;
27738
- message: string;
27739
- links?: {
27740
- docs: string;
27741
- schema: string;
27742
- };
27743
- issues?: {
27744
- message: string;
27745
- path?: (string | number)[];
27746
- schema?: string;
27747
- }[];
27748
- retryable?: boolean;
27749
- context?: unknown;
27750
- };
27751
- };
27752
- };
27753
- /** @description Unprocessable content */
27754
- 422: {
27755
- headers: {
27756
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27757
- "Retry-After"?: number;
27758
- [name: string]: unknown;
27759
- };
27760
- content: {
27761
- "application/json": {
27762
- code: string;
27763
- message: string;
27764
- links?: {
27765
- docs: string;
27766
- schema: string;
27767
- };
27768
- issues?: {
27769
- message: string;
27770
- path?: (string | number)[];
27771
- schema?: string;
27772
- }[];
27773
- retryable?: boolean;
27774
- context?: unknown;
27775
- };
27776
- };
27777
- };
27778
- /** @description Internal server error */
27779
- 500: {
27780
- headers: {
27781
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27782
- "Retry-After"?: number;
27783
- [name: string]: unknown;
27784
- };
27785
- content: {
27786
- "application/json": {
27787
- code: string;
27788
- message: string;
27789
- links?: {
27790
- docs: string;
27791
- schema: string;
27792
- };
27793
- issues?: {
27794
- message: string;
27795
- path?: (string | number)[];
27796
- schema?: string;
27797
- }[];
27798
- retryable?: boolean;
27799
- context?: unknown;
27800
- };
27801
- };
27802
- };
27803
- /** @description Service unavailable */
27804
- 503: {
27805
- headers: {
27806
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
27807
- "Retry-After"?: number;
27808
- [name: string]: unknown;
27809
- };
27810
- content: {
27811
- "application/json": {
27812
- code: string;
27813
- message: string;
27814
- links?: {
27815
- docs: string;
27816
- schema: string;
27817
- };
27818
- issues?: {
27819
- message: string;
27820
- path?: (string | number)[];
27821
- schema?: string;
27822
- }[];
27823
- retryable?: boolean;
27824
- context?: unknown;
27825
- };
27826
- };
27827
- };
27828
- };
27829
- };
27830
- getConnectionsByIdCsvImportPreviewByPreviewId: {
27831
- parameters: {
27832
- query?: never;
27833
- header?: never;
27834
- path: {
27835
- id: string;
27836
- previewId: string;
27837
- };
27838
- cookie?: never;
27839
- };
27840
- requestBody?: never;
27841
- responses: {
27842
- /** @description Successful response */
27843
- 200: {
27844
- headers: {
27845
- [name: string]: unknown;
27846
- };
27847
- content: {
27848
- "application/json": {
27849
- data: {
27850
- /** @constant */
27851
- status: "queued";
27852
- /** Format: uuid */
27853
- previewId: string;
27854
- /** Format: uuid */
27855
- syncId: string;
27856
- } | {
27857
- /** @constant */
27858
- status: "processing";
27859
- /** Format: uuid */
27860
- previewId: string;
27861
- /** Format: uuid */
27862
- syncId: string;
27863
- } | {
27864
- /** @constant */
27865
- status: "completed";
27866
- /** Format: uuid */
27867
- previewId: string;
27868
- /** Format: uuid */
27869
- syncId: string;
27870
- result: {
27871
- canImport: boolean;
27872
- columns: string[];
27873
- issues: {
27874
- code: string;
27875
- field?: string;
27876
- rowNumber: number;
27877
- message: string;
27878
- }[];
27879
- issueCounts: {
27880
- [key: string]: number;
27881
- };
27882
- logicalRecordCount: number;
27883
- resolutionCounts: {
27884
- matched: number;
27885
- unmatched: number;
27886
- ambiguous: number;
27887
- };
27888
- sourceHash: string;
27889
- /** @constant */
27890
- resource: "bankRecords";
27891
- mapping: {
27892
- /** @constant */
27893
- resource?: "bankRecords";
27894
- /** @constant */
27895
- version: 1;
27896
- /** @enum {string} */
27897
- delimiter: "," | ";" | "\t" | "|";
27898
- headerRow: number;
27899
- date: {
27900
- source?: string | null;
27901
- format?: ("yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy") | null;
27902
- };
27903
- description: {
27904
- sources: string[];
27905
- /** @constant */
27906
- operation: "join";
27907
- };
27908
- amount: {
27909
- /** @enum {string} */
27910
- mode: "signed" | "debitCredit";
27911
- source?: string | null;
27912
- debit?: string | null;
27913
- credit?: string | null;
27914
- /** @constant */
27915
- debitSign: -1;
27916
- /** @constant */
27917
- creditSign: 1;
27918
- };
27919
- excludedRows: number[];
27920
- };
27921
- totals: {
27922
- rows: number;
27923
- valid: number;
27924
- invalid: number;
27925
- excluded: number;
27926
- moneyIn: number;
27927
- moneyOut: number;
27928
- net: number;
27929
- };
27930
- } | {
27931
- canImport: boolean;
27932
- columns: string[];
27933
- issues: {
27934
- code: string;
27935
- field?: string;
27936
- rowNumber: number;
27937
- message: string;
27938
- }[];
27939
- issueCounts: {
27940
- [key: string]: number;
27941
- };
27942
- logicalRecordCount: number;
27943
- resolutionCounts: {
27944
- matched: number;
27945
- unmatched: number;
27946
- ambiguous: number;
27947
- };
27948
- sourceHash: string;
27949
- /** @constant */
27950
- resource: "owners";
27951
- mapping: {
27952
- /** @constant */
27953
- resource: "owners";
27954
- /** @constant */
27955
- version: 1;
27956
- /** @enum {string} */
27957
- delimiter: "," | ";" | "\t" | "|";
27958
- headerRow: number;
27959
- excludedRows: number[];
27960
- fields: {
27961
- listing: {
27962
- source?: string | null;
27963
- overrides: {
27964
- [key: string]: string;
27965
- };
27966
- };
27967
- ownerKind: {
27968
- source?: string | null;
27969
- /** @enum {string} */
27970
- constant?: "individual" | "company";
27971
- values: {
27972
- [key: string]: "individual" | "company";
27973
- };
27974
- };
27975
- firstName: {
27976
- source?: string | null;
27977
- };
27978
- lastName: {
27979
- source?: string | null;
27980
- };
27981
- companyName: {
27982
- source?: string | null;
27983
- };
27984
- companyType: {
27985
- source?: string | null;
27986
- values: {
27987
- [key: string]: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
27988
- };
27989
- };
27990
- ownerReference: {
27991
- source?: string | null;
27992
- overrides: {
27993
- [key: string]: string;
27994
- };
27995
- };
27996
- email: {
27997
- source?: string | null;
27998
- };
27999
- phone: {
28000
- source?: string | null;
28001
- };
28002
- taxIdentifier: {
28003
- source?: string | null;
28004
- };
28005
- address: {
28006
- source?: string | null;
28007
- };
28008
- unit: {
28009
- source?: string | null;
28010
- };
28011
- city: {
28012
- source?: string | null;
28013
- };
28014
- state: {
28015
- source?: string | null;
28016
- };
28017
- postalCode: {
28018
- source?: string | null;
28019
- };
28020
- country: {
28021
- source?: string | null;
28022
- };
28023
- payoutAccount: {
28024
- source?: string | null;
28025
- overrides: {
28026
- [key: string]: string;
28027
- };
28028
- };
28029
- };
28030
- };
28031
- totals: {
28032
- rows: number;
28033
- valid: number;
28034
- invalid: number;
28035
- excluded: number;
28036
- owners: number;
28037
- listings: number;
28038
- create: number;
28039
- update: number;
28040
- conflicts: number;
28041
- };
28042
- } | {
28043
- canImport: boolean;
28044
- columns: string[];
28045
- issues: {
28046
- code: string;
28047
- field?: string;
28048
- rowNumber: number;
28049
- message: string;
28050
- }[];
28051
- issueCounts: {
28052
- [key: string]: number;
28053
- };
28054
- logicalRecordCount: number;
28055
- resolutionCounts: {
28056
- matched: number;
28057
- unmatched: number;
28058
- ambiguous: number;
28059
- };
28060
- sourceHash: string;
28061
- /** @constant */
28062
- resource: "expenses";
28063
- mapping: {
28064
- /** @constant */
28065
- resource: "expenses";
28066
- /** @constant */
28067
- version: 1;
28068
- /** @enum {string} */
28069
- delimiter: "," | ";" | "\t" | "|";
28070
- headerRow: number;
28071
- excludedRows: number[];
28072
- fields: {
28073
- billReference: {
28074
- source?: string | null;
28075
- };
28076
- issueDate: {
28077
- source?: string | null;
28078
- /** @enum {string} */
28079
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
28080
- };
28081
- vendor: {
28082
- source?: string | null;
28083
- overrides: {
28084
- [key: string]: string;
28085
- };
28086
- };
28087
- status: {
28088
- source?: string | null;
28089
- /** @enum {string} */
28090
- constant?: "paid" | "unpaid";
28091
- values: {
28092
- [key: string]: "paid" | "unpaid";
28093
- };
28094
- };
28095
- paymentDate: {
28096
- source?: string | null;
28097
- /** @enum {string} */
28098
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
28099
- };
28100
- bankAccount: {
28101
- source?: string | null;
28102
- overrides: {
28103
- [key: string]: string;
28104
- };
28105
- };
28106
- currency: {
28107
- source?: string | null;
28108
- };
28109
- description: {
28110
- source?: string | null;
28111
- };
28112
- lineDescription: {
28113
- source?: string | null;
28114
- };
28115
- expenseAccount: {
28116
- source?: string | null;
28117
- overrides: {
28118
- [key: string]: string;
28119
- };
28120
- };
28121
- appliedAmount: {
28122
- source?: string | null;
28123
- };
28124
- reservation: {
28125
- source?: string | null;
28126
- overrides: {
28127
- [key: string]: string;
28128
- };
28129
- };
28130
- listing: {
28131
- source?: string | null;
28132
- overrides: {
28133
- [key: string]: string;
28134
- };
28135
- };
28136
- billToOwner: {
28137
- source?: string | null;
28138
- constant?: boolean;
28139
- values: {
28140
- [key: string]: boolean;
28141
- };
28142
- };
28143
- markup: {
28144
- source?: string | null;
28145
- };
28146
- markupTax: {
28147
- source?: string | null;
28148
- overrides: {
28149
- [key: string]: string;
28150
- };
28151
- };
28152
- };
28153
- };
28154
- totals: {
28155
- rows: number;
28156
- expenses: number;
28157
- valid: number;
28158
- invalid: number;
28159
- excluded: number;
28160
- applied: number;
28161
- markup: number;
28162
- byCurrency: {
28163
- [key: string]: {
28164
- applied: number;
28165
- markup: number;
28166
- };
28167
- };
28168
- };
28169
- } | {
28170
- canImport: boolean;
28171
- columns: string[];
28172
- issues: {
28173
- code: string;
28174
- field?: string;
28175
- rowNumber: number;
28176
- message: string;
28177
- }[];
28178
- issueCounts: {
28179
- [key: string]: number;
28180
- };
28181
- logicalRecordCount: number;
28182
- resolutionCounts: {
28183
- matched: number;
28184
- unmatched: number;
28185
- ambiguous: number;
28186
- };
28187
- sourceHash: string;
28188
- /** @constant */
28189
- resource: "vendors";
28190
- mapping: {
28191
- /** @constant */
28192
- resource: "vendors";
28193
- /** @constant */
28194
- version: 1;
28195
- /** @enum {string} */
28196
- delimiter: "," | ";" | "\t" | "|";
28197
- headerRow: number;
28198
- excludedRows: number[];
28199
- fields: {
28200
- vendorKind: {
28201
- source?: string | null;
28202
- /** @enum {string} */
28203
- constant?: "individual" | "company";
28204
- values: {
28205
- [key: string]: "individual" | "company";
28206
- };
28207
- };
28208
- firstName: {
28209
- source?: string | null;
28210
- };
28211
- lastName: {
28212
- source?: string | null;
28213
- };
28214
- companyName: {
28215
- source?: string | null;
28216
- };
28217
- companyType: {
28218
- source?: string | null;
28219
- values: {
28220
- [key: string]: "c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate";
28221
- };
28222
- };
28223
- vendorReference: {
28224
- source?: string | null;
28225
- overrides: {
28226
- [key: string]: string;
28227
- };
28228
- };
28229
- email: {
28230
- source?: string | null;
28231
- };
28232
- phone: {
28233
- source?: string | null;
28234
- };
28235
- taxIdentifier: {
28236
- source?: string | null;
28237
- };
28238
- address: {
28239
- source?: string | null;
28240
- };
28241
- unit: {
28242
- source?: string | null;
28243
- };
28244
- city: {
28245
- source?: string | null;
28246
- };
28247
- state: {
28248
- source?: string | null;
28249
- };
28250
- postalCode: {
28251
- source?: string | null;
28252
- };
28253
- country: {
28254
- source?: string | null;
28255
- };
28256
- };
28257
- };
28258
- totals: {
28259
- rows: number;
28260
- valid: number;
28261
- invalid: number;
28262
- excluded: number;
28263
- create: number;
28264
- update: number;
28265
- duplicate: number;
28266
- ambiguous: number;
28267
- };
28268
- } | {
28269
- canImport: boolean;
28270
- columns: string[];
28271
- issues: {
28272
- code: string;
28273
- field?: string;
28274
- rowNumber: number;
28275
- message: string;
28276
- }[];
28277
- issueCounts: {
28278
- [key: string]: number;
28279
- };
28280
- logicalRecordCount: number;
28281
- resolutionCounts: {
28282
- matched: number;
28283
- unmatched: number;
28284
- ambiguous: number;
28285
- };
28286
- sourceHash: string;
28287
- /** @constant */
28288
- resource: "deposits";
28289
- mapping: {
28290
- /** @constant */
28291
- resource: "deposits";
28292
- /** @constant */
28293
- version: 1;
28294
- /** @enum {string} */
28295
- delimiter: "," | ";" | "\t" | "|";
28296
- headerRow: number;
28297
- excludedRows: number[];
28298
- fields: {
28299
- reference: {
28300
- source?: string | null;
28301
- };
28302
- date: {
28303
- source?: string | null;
28304
- /** @enum {string} */
28305
- format?: "yyyy-mm-dd" | "mm/dd/yyyy" | "dd/mm/yyyy" | "dd.mm.yyyy";
28306
- };
28307
- bankAccount: {
28308
- source?: string | null;
28309
- overrides: {
28310
- [key: string]: string;
28311
- };
28312
- };
28313
- description: {
28314
- source?: string | null;
28315
- };
28316
- currency: {
28317
- source?: string | null;
28318
- };
28319
- reservation: {
28320
- source?: string | null;
28321
- overrides: {
28322
- [key: string]: string;
28323
- };
28324
- };
28325
- contact: {
28326
- source?: string | null;
28327
- overrides: {
28328
- [key: string]: string;
28329
- };
28330
- };
28331
- listing: {
28332
- source?: string | null;
28333
- overrides: {
28334
- [key: string]: string;
28335
- };
28336
- };
28337
- account: {
28338
- source?: string | null;
28339
- overrides: {
28340
- [key: string]: string;
28341
- };
28342
- };
28343
- lineDescription: {
28344
- source?: string | null;
28345
- };
28346
- appliedAmount: {
28347
- source?: string | null;
28348
- };
28349
- merchantFee: {
28350
- source?: string | null;
28351
- };
28352
- channelFee: {
28353
- source?: string | null;
28354
- };
28355
- reserve: {
28356
- source?: string | null;
28357
- };
28358
- coHostPayout: {
28359
- source?: string | null;
28360
- };
28361
- vat: {
28362
- source?: string | null;
28363
- };
28364
- };
28365
- };
28366
- totals: {
28367
- rows: number;
28368
- deposits: number;
28369
- valid: number;
28370
- invalid: number;
28371
- excluded: number;
28372
- applied: number;
28373
- merchantFee: number;
28374
- channelFee: number;
28375
- reserve: number;
28376
- coHostPayout: number;
28377
- vat: number;
28378
- net: number;
28379
- byCurrency: {
28380
- [key: string]: {
28381
- applied: number;
28382
- merchantFee: number;
28383
- channelFee: number;
28384
- reserve: number;
28385
- coHostPayout: number;
28386
- vat: number;
28387
- net: number;
28388
- };
28389
- };
28390
- };
28391
- };
28392
- } | {
28393
- /** @constant */
28394
- status: "failed";
28395
- /** Format: uuid */
28396
- previewId: string;
28397
- /** Format: uuid */
28398
- syncId: string;
28399
- error: string;
28400
- };
28401
- };
28402
- };
28403
- };
28404
- /** @description Bad request */
28405
- 400: {
28406
- headers: {
28407
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28408
- "Retry-After"?: number;
28409
- [name: string]: unknown;
28410
- };
28411
- content: {
28412
- "application/json": {
28413
- code: string;
28414
- message: string;
28415
- links?: {
28416
- docs: string;
28417
- schema: string;
28418
- };
28419
- issues?: {
28420
- message: string;
28421
- path?: (string | number)[];
28422
- schema?: string;
28423
- }[];
28424
- retryable?: boolean;
28425
- context?: unknown;
28426
- };
28427
- };
28428
- };
28429
- /** @description Unauthorized */
28430
- 401: {
28431
- headers: {
28432
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28433
- "Retry-After"?: number;
28434
- [name: string]: unknown;
28435
- };
28436
- content: {
28437
- "application/json": {
28438
- code: string;
28439
- message: string;
28440
- links?: {
28441
- docs: string;
28442
- schema: string;
28443
- };
28444
- issues?: {
28445
- message: string;
28446
- path?: (string | number)[];
28447
- schema?: string;
28448
- }[];
28449
- retryable?: boolean;
28450
- context?: unknown;
28451
- };
28452
- };
28453
- };
28454
- /** @description Forbidden */
28455
- 403: {
28456
- headers: {
28457
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28458
- "Retry-After"?: number;
28459
- [name: string]: unknown;
28460
- };
28461
- content: {
28462
- "application/json": {
28463
- code: string;
28464
- message: string;
28465
- links?: {
28466
- docs: string;
28467
- schema: string;
28468
- };
28469
- issues?: {
28470
- message: string;
28471
- path?: (string | number)[];
28472
- schema?: string;
28473
- }[];
28474
- retryable?: boolean;
28475
- context?: unknown;
28476
- };
28477
- };
28478
- };
28479
- /** @description Not found */
28480
- 404: {
28481
- headers: {
28482
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28483
- "Retry-After"?: number;
28484
- [name: string]: unknown;
28485
- };
28486
- content: {
28487
- "application/json": {
28488
- code: string;
28489
- message: string;
28490
- links?: {
28491
- docs: string;
28492
- schema: string;
28493
- };
28494
- issues?: {
28495
- message: string;
28496
- path?: (string | number)[];
28497
- schema?: string;
28498
- }[];
28499
- retryable?: boolean;
28500
- context?: unknown;
28501
- };
28502
- };
28503
- };
28504
- /** @description Conflict */
28505
- 409: {
28506
- headers: {
28507
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28508
- "Retry-After"?: number;
28509
- [name: string]: unknown;
28510
- };
28511
- content: {
28512
- "application/json": {
28513
- code: string;
28514
- message: string;
28515
- links?: {
28516
- docs: string;
28517
- schema: string;
28518
- };
28519
- issues?: {
28520
- message: string;
28521
- path?: (string | number)[];
28522
- schema?: string;
28523
- }[];
28524
- retryable?: boolean;
28525
- context?: unknown;
28526
- };
28527
- };
28528
- };
28529
- /** @description Gone */
28530
- 410: {
28531
- headers: {
28532
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28533
- "Retry-After"?: number;
28534
- [name: string]: unknown;
28535
- };
28536
- content: {
28537
- "application/json": {
28538
- code: string;
28539
- message: string;
28540
- links?: {
28541
- docs: string;
28542
- schema: string;
28543
- };
28544
- issues?: {
28545
- message: string;
28546
- path?: (string | number)[];
28547
- schema?: string;
28548
- }[];
28549
- retryable?: boolean;
28550
- context?: unknown;
28551
- };
28552
- };
28553
- };
28554
- /** @description Unprocessable content */
28555
- 422: {
28556
- headers: {
28557
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28558
- "Retry-After"?: number;
28559
- [name: string]: unknown;
28560
- };
28561
- content: {
28562
- "application/json": {
28563
- code: string;
28564
- message: string;
28565
- links?: {
28566
- docs: string;
28567
- schema: string;
28568
- };
28569
- issues?: {
28570
- message: string;
28571
- path?: (string | number)[];
28572
- schema?: string;
28573
- }[];
28574
- retryable?: boolean;
28575
- context?: unknown;
28576
- };
28577
- };
28578
- };
28579
- /** @description Internal server error */
28580
- 500: {
28581
- headers: {
28582
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28583
- "Retry-After"?: number;
28584
- [name: string]: unknown;
28585
- };
28586
- content: {
28587
- "application/json": {
28588
- code: string;
28589
- message: string;
28590
- links?: {
28591
- docs: string;
28592
- schema: string;
28593
- };
28594
- issues?: {
28595
- message: string;
28596
- path?: (string | number)[];
28597
- schema?: string;
28598
- }[];
28599
- retryable?: boolean;
28600
- context?: unknown;
28601
- };
28602
- };
28603
- };
28604
- /** @description Service unavailable */
28605
- 503: {
28606
- headers: {
28607
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28608
- "Retry-After"?: number;
28609
- [name: string]: unknown;
28610
- };
28611
- content: {
28612
- "application/json": {
28613
- code: string;
28614
- message: string;
28615
- links?: {
28616
- docs: string;
28617
- schema: string;
28618
- };
28619
- issues?: {
28620
- message: string;
28621
- path?: (string | number)[];
28622
- schema?: string;
28623
- }[];
28624
- retryable?: boolean;
28625
- context?: unknown;
28626
- };
28627
- };
28628
- };
28629
- };
28630
- };
28631
- getConnectionsByIdCsvImportPreviewByPreviewIdRecords: {
28632
- parameters: {
28633
- query?: {
28634
- cursor?: string;
28635
- limit?: number;
28636
- state?: "all" | "valid" | "invalid" | "excluded" | "unresolved";
28637
- };
28638
- header?: never;
28639
- path: {
28640
- id: string;
28641
- previewId: string;
28642
- };
28643
- cookie?: never;
28644
- };
28645
- requestBody?: never;
28646
- responses: {
28647
- /** @description Successful response */
28648
- 200: {
28649
- headers: {
28650
- [name: string]: unknown;
28651
- };
28652
- content: {
28653
- "application/json": {
28654
- data: {
28655
- /** @enum {string} */
28656
- resource: "bankRecords" | "owners" | "expenses" | "vendors" | "deposits";
28657
- recordRef: string;
28658
- rowNumbers: number[];
28659
- source: {
28660
- [key: string]: string | null;
28661
- }[];
28662
- transformed?: {
28663
- [key: string]: unknown;
28664
- } | null;
28665
- systemExclusion?: {
28666
- /** @constant */
28667
- code: "beforeBankRecordStartDate";
28668
- bankRecordStartDate: string;
28669
- };
28670
- resolutions: {
28671
- field: string;
28672
- sourceValue: string;
28673
- /** @enum {string} */
28674
- state: "matched" | "unmatched" | "ambiguous";
28675
- candidates: {
28676
- /** Format: uuid */
28677
- id: string;
28678
- label: string;
28679
- secondaryLabel?: string;
28680
- }[];
28681
- candidateCount: number;
28682
- candidatesTruncated: boolean;
28683
- /** Format: uuid */
28684
- selectedId?: string;
28685
- }[];
28686
- issues: {
28687
- code: string;
28688
- field?: string;
28689
- rowNumber: number;
28690
- message: string;
28691
- }[];
28692
- excluded: boolean;
28693
- /** @enum {string} */
28694
- state: "valid" | "invalid" | "excluded" | "unresolved";
28695
- }[];
28696
- nextCursor: string | null;
28697
- };
28698
- };
28699
- };
28700
- /** @description Bad request */
28701
- 400: {
28702
- headers: {
28703
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28704
- "Retry-After"?: number;
28705
- [name: string]: unknown;
28706
- };
28707
- content: {
28708
- "application/json": {
28709
- code: string;
28710
- message: string;
28711
- links?: {
28712
- docs: string;
28713
- schema: string;
28714
- };
28715
- issues?: {
28716
- message: string;
28717
- path?: (string | number)[];
28718
- schema?: string;
28719
- }[];
28720
- retryable?: boolean;
28721
- context?: unknown;
28722
- };
28723
- };
28724
- };
28725
- /** @description Unauthorized */
28726
- 401: {
28727
- headers: {
28728
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28729
- "Retry-After"?: number;
28730
- [name: string]: unknown;
28731
- };
28732
- content: {
28733
- "application/json": {
28734
- code: string;
28735
- message: string;
28736
- links?: {
28737
- docs: string;
28738
- schema: string;
28739
- };
28740
- issues?: {
28741
- message: string;
28742
- path?: (string | number)[];
28743
- schema?: string;
28744
- }[];
28745
- retryable?: boolean;
28746
- context?: unknown;
28747
- };
28748
- };
28749
- };
28750
- /** @description Forbidden */
28751
- 403: {
28752
- headers: {
28753
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28754
- "Retry-After"?: number;
28755
- [name: string]: unknown;
28756
- };
28757
- content: {
28758
- "application/json": {
28759
- code: string;
28760
- message: string;
28761
- links?: {
28762
- docs: string;
28763
- schema: string;
28764
- };
28765
- issues?: {
28766
- message: string;
28767
- path?: (string | number)[];
28768
- schema?: string;
28769
- }[];
28770
- retryable?: boolean;
28771
- context?: unknown;
28772
- };
28773
- };
28774
- };
28775
- /** @description Not found */
28776
- 404: {
28777
- headers: {
28778
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28779
- "Retry-After"?: number;
28780
- [name: string]: unknown;
28781
- };
28782
- content: {
28783
- "application/json": {
28784
- code: string;
28785
- message: string;
28786
- links?: {
28787
- docs: string;
28788
- schema: string;
28789
- };
28790
- issues?: {
28791
- message: string;
28792
- path?: (string | number)[];
28793
- schema?: string;
28794
- }[];
28795
- retryable?: boolean;
28796
- context?: unknown;
28797
- };
28798
- };
28799
- };
28800
- /** @description Conflict */
28801
- 409: {
28802
- headers: {
28803
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28804
- "Retry-After"?: number;
28805
- [name: string]: unknown;
28806
- };
28807
- content: {
28808
- "application/json": {
28809
- code: string;
28810
- message: string;
28811
- links?: {
28812
- docs: string;
28813
- schema: string;
28814
- };
28815
- issues?: {
28816
- message: string;
28817
- path?: (string | number)[];
28818
- schema?: string;
28819
- }[];
28820
- retryable?: boolean;
28821
- context?: unknown;
28822
- };
28823
- };
28824
- };
28825
- /** @description Gone */
28826
- 410: {
28827
- headers: {
28828
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28829
- "Retry-After"?: number;
28830
- [name: string]: unknown;
28831
- };
28832
- content: {
28833
- "application/json": {
28834
- code: string;
28835
- message: string;
28836
- links?: {
28837
- docs: string;
28838
- schema: string;
28839
- };
28840
- issues?: {
28841
- message: string;
28842
- path?: (string | number)[];
28843
- schema?: string;
28844
- }[];
28845
- retryable?: boolean;
28846
- context?: unknown;
28847
- };
28848
- };
28849
- };
28850
- /** @description Unprocessable content */
28851
- 422: {
28852
- headers: {
28853
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28854
- "Retry-After"?: number;
28855
- [name: string]: unknown;
28856
- };
28857
- content: {
28858
- "application/json": {
28859
- code: string;
28860
- message: string;
28861
- links?: {
28862
- docs: string;
28863
- schema: string;
28864
- };
28865
- issues?: {
28866
- message: string;
28867
- path?: (string | number)[];
28868
- schema?: string;
28869
- }[];
28870
- retryable?: boolean;
28871
- context?: unknown;
28872
- };
28873
- };
28874
- };
28875
- /** @description Internal server error */
28876
- 500: {
28877
- headers: {
28878
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28879
- "Retry-After"?: number;
28880
- [name: string]: unknown;
28881
- };
28882
- content: {
28883
- "application/json": {
28884
- code: string;
28885
- message: string;
28886
- links?: {
28887
- docs: string;
28888
- schema: string;
28889
- };
28890
- issues?: {
28891
- message: string;
28892
- path?: (string | number)[];
28893
- schema?: string;
28894
- }[];
28895
- retryable?: boolean;
28896
- context?: unknown;
28897
- };
28898
- };
28899
- };
28900
- /** @description Service unavailable */
28901
- 503: {
28902
- headers: {
28903
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28904
- "Retry-After"?: number;
28905
- [name: string]: unknown;
28906
- };
28907
- content: {
28908
- "application/json": {
28909
- code: string;
28910
- message: string;
28911
- links?: {
28912
- docs: string;
28913
- schema: string;
28914
- };
28915
- issues?: {
28916
- message: string;
28917
- path?: (string | number)[];
28918
- schema?: string;
28919
- }[];
28920
- retryable?: boolean;
28921
- context?: unknown;
28922
- };
28923
- };
28924
- };
28925
- };
28926
- };
28927
- postConnectionsByIdCsvImportUploads: {
28928
- parameters: {
28929
- query?: never;
28930
- header?: never;
28931
- path: {
28932
- id: string;
28933
- };
28934
- cookie?: never;
28935
- };
28936
- requestBody?: {
28937
- content: {
28938
- "application/json": {
28939
- fileName: string;
28940
- fileSize: number;
28941
- };
28942
- };
28943
- };
28944
- responses: {
28945
- /** @description Successful response */
28946
- 200: {
28947
- headers: {
28948
- [name: string]: unknown;
28949
- };
28950
- content: {
28951
- "application/json": {
28952
- /** Format: date-time */
28953
- expiresAt: string;
28954
- uploadRef: string;
28955
- /** Format: uri */
28956
- uploadUrl: string;
28957
- };
28958
- };
28959
- };
28960
- /** @description Bad request */
28961
- 400: {
28962
- headers: {
28963
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28964
- "Retry-After"?: number;
28965
- [name: string]: unknown;
28966
- };
28967
- content: {
28968
- "application/json": {
28969
- code: string;
28970
- message: string;
28971
- links?: {
28972
- docs: string;
28973
- schema: string;
28974
- };
28975
- issues?: {
28976
- message: string;
28977
- path?: (string | number)[];
28978
- schema?: string;
28979
- }[];
28980
- retryable?: boolean;
28981
- context?: unknown;
28982
- };
28983
- };
28984
- };
28985
- /** @description Unauthorized */
28986
- 401: {
28987
- headers: {
28988
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
28989
- "Retry-After"?: number;
28990
- [name: string]: unknown;
28991
- };
28992
- content: {
28993
- "application/json": {
28994
- code: string;
28995
- message: string;
28996
- links?: {
28997
- docs: string;
28998
- schema: string;
28999
- };
29000
- issues?: {
29001
- message: string;
29002
- path?: (string | number)[];
29003
- schema?: string;
29004
- }[];
29005
- retryable?: boolean;
29006
- context?: unknown;
29007
- };
29008
- };
29009
- };
29010
- /** @description Forbidden */
29011
- 403: {
29012
- headers: {
29013
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29014
- "Retry-After"?: number;
29015
- [name: string]: unknown;
29016
- };
29017
- content: {
29018
- "application/json": {
29019
- code: string;
29020
- message: string;
29021
- links?: {
29022
- docs: string;
29023
- schema: string;
29024
- };
29025
- issues?: {
29026
- message: string;
29027
- path?: (string | number)[];
29028
- schema?: string;
29029
- }[];
29030
- retryable?: boolean;
29031
- context?: unknown;
29032
- };
29033
- };
29034
- };
29035
- /** @description Not found */
29036
- 404: {
29037
- headers: {
29038
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29039
- "Retry-After"?: number;
29040
- [name: string]: unknown;
29041
- };
29042
- content: {
29043
- "application/json": {
29044
- code: string;
29045
- message: string;
29046
- links?: {
29047
- docs: string;
29048
- schema: string;
29049
- };
29050
- issues?: {
29051
- message: string;
29052
- path?: (string | number)[];
29053
- schema?: string;
29054
- }[];
29055
- retryable?: boolean;
29056
- context?: unknown;
29057
- };
29058
- };
29059
- };
29060
- /** @description Conflict */
29061
- 409: {
29062
- headers: {
29063
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29064
- "Retry-After"?: number;
29065
- [name: string]: unknown;
29066
- };
29067
- content: {
29068
- "application/json": {
29069
- code: string;
29070
- message: string;
29071
- links?: {
29072
- docs: string;
29073
- schema: string;
29074
- };
29075
- issues?: {
29076
- message: string;
29077
- path?: (string | number)[];
29078
- schema?: string;
29079
- }[];
29080
- retryable?: boolean;
29081
- context?: unknown;
29082
- };
29083
- };
29084
- };
29085
- /** @description Gone */
29086
- 410: {
29087
- headers: {
29088
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29089
- "Retry-After"?: number;
29090
- [name: string]: unknown;
29091
- };
29092
- content: {
29093
- "application/json": {
29094
- code: string;
29095
- message: string;
29096
- links?: {
29097
- docs: string;
29098
- schema: string;
29099
- };
29100
- issues?: {
29101
- message: string;
29102
- path?: (string | number)[];
29103
- schema?: string;
29104
- }[];
29105
- retryable?: boolean;
29106
- context?: unknown;
29107
- };
29108
- };
29109
- };
29110
- /** @description Unprocessable content */
29111
- 422: {
29112
- headers: {
29113
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29114
- "Retry-After"?: number;
29115
- [name: string]: unknown;
29116
- };
29117
- content: {
29118
- "application/json": {
29119
- code: string;
29120
- message: string;
29121
- links?: {
29122
- docs: string;
29123
- schema: string;
29124
- };
29125
- issues?: {
29126
- message: string;
29127
- path?: (string | number)[];
29128
- schema?: string;
29129
- }[];
29130
- retryable?: boolean;
29131
- context?: unknown;
29132
- };
29133
- };
29134
- };
29135
- /** @description Internal server error */
29136
- 500: {
29137
- headers: {
29138
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29139
- "Retry-After"?: number;
29140
- [name: string]: unknown;
29141
- };
29142
- content: {
29143
- "application/json": {
29144
- code: string;
29145
- message: string;
29146
- links?: {
29147
- docs: string;
29148
- schema: string;
29149
- };
29150
- issues?: {
29151
- message: string;
29152
- path?: (string | number)[];
29153
- schema?: string;
29154
- }[];
29155
- retryable?: boolean;
29156
- context?: unknown;
29157
- };
29158
- };
29159
- };
29160
- /** @description Service unavailable */
29161
- 503: {
29162
- headers: {
29163
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29164
- "Retry-After"?: number;
29165
- [name: string]: unknown;
29166
- };
29167
- content: {
29168
- "application/json": {
29169
- code: string;
29170
- message: string;
29171
- links?: {
29172
- docs: string;
29173
- schema: string;
29174
- };
29175
- issues?: {
29176
- message: string;
29177
- path?: (string | number)[];
29178
- schema?: string;
29179
- }[];
29180
- retryable?: boolean;
29181
- context?: unknown;
29182
- };
29183
- };
29184
- };
29185
- };
29186
- };
29187
- putConnectionsByIdCsvImportUploadsByUploadRef: {
29188
- parameters: {
29189
- query?: never;
29190
- header?: never;
29191
- path: {
29192
- id: string;
29193
- uploadRef: string;
29194
- };
29195
- cookie?: never;
29196
- };
29197
- requestBody?: never;
29198
- responses: {
29199
- /** @description Successful response */
29200
- 200: {
29201
- headers: {
29202
- [name: string]: unknown;
29203
- };
29204
- content: {
29205
- "application/json": {
29206
- /** @constant */
29207
- status: "uploaded";
29208
- };
29209
- };
29210
- };
29211
- /** @description Bad request */
29212
- 400: {
29213
- headers: {
29214
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29215
- "Retry-After"?: number;
29216
- [name: string]: unknown;
29217
- };
29218
- content: {
29219
- "application/json": {
29220
- code: string;
29221
- message: string;
29222
- links?: {
29223
- docs: string;
29224
- schema: string;
29225
- };
29226
- issues?: {
29227
- message: string;
29228
- path?: (string | number)[];
29229
- schema?: string;
29230
- }[];
29231
- retryable?: boolean;
29232
- context?: unknown;
29233
- };
29234
- };
29235
- };
29236
- /** @description Unauthorized */
29237
- 401: {
29238
- headers: {
29239
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29240
- "Retry-After"?: number;
29241
- [name: string]: unknown;
29242
- };
29243
- content: {
29244
- "application/json": {
29245
- code: string;
29246
- message: string;
29247
- links?: {
29248
- docs: string;
29249
- schema: string;
29250
- };
29251
- issues?: {
29252
- message: string;
29253
- path?: (string | number)[];
29254
- schema?: string;
29255
- }[];
29256
- retryable?: boolean;
29257
- context?: unknown;
29258
- };
29259
- };
29260
- };
29261
- /** @description Forbidden */
29262
- 403: {
29263
- headers: {
29264
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29265
- "Retry-After"?: number;
29266
- [name: string]: unknown;
29267
- };
29268
- content: {
29269
- "application/json": {
29270
- code: string;
29271
- message: string;
29272
- links?: {
29273
- docs: string;
29274
- schema: string;
29275
- };
29276
- issues?: {
29277
- message: string;
29278
- path?: (string | number)[];
29279
- schema?: string;
29280
- }[];
29281
- retryable?: boolean;
29282
- context?: unknown;
29283
- };
29284
- };
29285
- };
29286
- /** @description Not found */
29287
- 404: {
29288
- headers: {
29289
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29290
- "Retry-After"?: number;
29291
- [name: string]: unknown;
29292
- };
29293
- content: {
29294
- "application/json": {
29295
- code: string;
29296
- message: string;
29297
- links?: {
29298
- docs: string;
29299
- schema: string;
29300
- };
29301
- issues?: {
29302
- message: string;
29303
- path?: (string | number)[];
29304
- schema?: string;
29305
- }[];
29306
- retryable?: boolean;
29307
- context?: unknown;
29308
- };
29309
- };
29310
- };
29311
- /** @description Conflict */
29312
- 409: {
29313
- headers: {
29314
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29315
- "Retry-After"?: number;
29316
- [name: string]: unknown;
29317
- };
29318
- content: {
29319
- "application/json": {
29320
- code: string;
29321
- message: string;
29322
- links?: {
29323
- docs: string;
29324
- schema: string;
29325
- };
29326
- issues?: {
29327
- message: string;
29328
- path?: (string | number)[];
29329
- schema?: string;
29330
- }[];
29331
- retryable?: boolean;
29332
- context?: unknown;
29333
- };
29334
- };
29335
- };
29336
- /** @description Gone */
29337
- 410: {
29338
- headers: {
29339
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29340
- "Retry-After"?: number;
29341
- [name: string]: unknown;
29342
- };
29343
- content: {
29344
- "application/json": {
29345
- code: string;
29346
- message: string;
29347
- links?: {
29348
- docs: string;
29349
- schema: string;
29350
- };
29351
- issues?: {
29352
- message: string;
29353
- path?: (string | number)[];
29354
- schema?: string;
29355
- }[];
29356
- retryable?: boolean;
29357
- context?: unknown;
29358
- };
29359
- };
29360
- };
29361
- /** @description Unprocessable content */
29362
- 422: {
29363
- headers: {
29364
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29365
- "Retry-After"?: number;
29366
- [name: string]: unknown;
29367
- };
29368
- content: {
29369
- "application/json": {
29370
- code: string;
29371
- message: string;
29372
- links?: {
29373
- docs: string;
29374
- schema: string;
29375
- };
29376
- issues?: {
29377
- message: string;
29378
- path?: (string | number)[];
29379
- schema?: string;
29380
- }[];
29381
- retryable?: boolean;
29382
- context?: unknown;
29383
- };
29384
- };
29385
- };
29386
- /** @description Internal server error */
29387
- 500: {
29388
- headers: {
29389
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29390
- "Retry-After"?: number;
29391
- [name: string]: unknown;
29392
- };
29393
- content: {
29394
- "application/json": {
29395
- code: string;
29396
- message: string;
29397
- links?: {
29398
- docs: string;
29399
- schema: string;
29400
- };
29401
- issues?: {
29402
- message: string;
29403
- path?: (string | number)[];
29404
- schema?: string;
29405
- }[];
29406
- retryable?: boolean;
29407
- context?: unknown;
29408
- };
29409
- };
29410
- };
29411
- /** @description Service unavailable */
29412
- 503: {
29413
- headers: {
29414
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
29415
- "Retry-After"?: number;
29416
- [name: string]: unknown;
29417
- };
29418
- content: {
29419
- "application/json": {
29420
- code: string;
29421
- message: string;
29422
- links?: {
29423
- docs: string;
29424
- schema: string;
29425
- };
29426
- issues?: {
29427
- message: string;
29428
- path?: (string | number)[];
29429
- schema?: string;
29430
- }[];
29431
- retryable?: boolean;
29432
- context?: unknown;
29433
- };
29434
- };
29435
- };
29436
- };
29437
- };
29438
- getConnectionsByIdCsvImportBySyncId: {
29439
- parameters: {
29440
- query?: never;
29441
- header?: never;
29442
- path: {
29443
- id: string;
29444
- syncId: string;
29445
- };
29446
- cookie?: never;
29447
- };
29448
- requestBody?: never;
29449
- responses: {
29450
- /** @description Successful response */
29451
- 200: {
29452
- headers: {
29453
- [name: string]: unknown;
29454
- };
29455
- content: {
29456
- "application/json": {
29457
- data: ({
29458
- syncId: string;
29459
- /** @enum {string} */
29460
- status: "completed";
29461
- } | {
29462
- /** @enum {string} */
29463
- status: "failed";
29464
- syncId: string;
29465
- error: string;
29466
- parseErrors?: {
29467
- rowNumber: number;
29468
- message: string;
29469
- }[];
29470
- }) | {
29471
- syncId: string;
29472
- /** @enum {string} */
29473
- status: "queued";
29474
25967
  };
29475
25968
  };
29476
25969
  };