@vrplatform/api 1.3.1-5005 → 1.3.1-5019

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.
@@ -417,6 +417,48 @@ export interface paths {
417
417
  patch?: never;
418
418
  trace?: never;
419
419
  };
420
+ "/audit/events": {
421
+ parameters: {
422
+ query?: never;
423
+ header?: never;
424
+ path?: never;
425
+ cookie?: never;
426
+ };
427
+ /**
428
+ * @description List public, upsertable audit events for the selected team. Posting changes are omitted by default; use include=postingChanges to expand them. Results are ordered by updatedAt and id so later accounting revisions reappear in ascending synchronization feeds. Ascending reads trail real time by a short visibility lag so concurrently committed revisions are never skipped.
429
+ *
430
+ * Required scope: audit:read
431
+ */
432
+ get: operations["getAuditEvents"];
433
+ put?: never;
434
+ post?: never;
435
+ delete?: never;
436
+ options?: never;
437
+ head?: never;
438
+ patch?: never;
439
+ trace?: never;
440
+ };
441
+ "/audit/events/{id}": {
442
+ parameters: {
443
+ query?: never;
444
+ header?: never;
445
+ path?: never;
446
+ cookie?: never;
447
+ };
448
+ /**
449
+ * @description Get one team-scoped public audit event with signed accounting posting-bucket before and after totals. Internal journal rows and effect mechanics are never returned.
450
+ *
451
+ * Required scope: audit:read
452
+ */
453
+ get: operations["getAuditEventsById"];
454
+ put?: never;
455
+ post?: never;
456
+ delete?: never;
457
+ options?: never;
458
+ head?: never;
459
+ patch?: never;
460
+ trace?: never;
461
+ };
420
462
  "/audit/journal-deltas": {
421
463
  parameters: {
422
464
  query?: never;
@@ -2913,6 +2955,27 @@ export interface paths {
2913
2955
  patch?: never;
2914
2956
  trace?: never;
2915
2957
  };
2958
+ "/partner/audit-events": {
2959
+ parameters: {
2960
+ query?: never;
2961
+ header?: never;
2962
+ path?: never;
2963
+ cookie?: never;
2964
+ };
2965
+ /**
2966
+ * @description List public audit events for managed teams in one regional partition. Posting changes are omitted by default; use include=postingChanges to expand them. Synchronize each data region independently with order=asc and upsert repeated event IDs by revision. Ascending reads trail real time by a short visibility lag so concurrently committed revisions are never skipped.
2967
+ *
2968
+ * Required scope: audit:read
2969
+ */
2970
+ get: operations["listPartnerAuditEvents"];
2971
+ put?: never;
2972
+ post?: never;
2973
+ delete?: never;
2974
+ options?: never;
2975
+ head?: never;
2976
+ patch?: never;
2977
+ trace?: never;
2978
+ };
2916
2979
  "/partner/billing": {
2917
2980
  parameters: {
2918
2981
  query?: never;
@@ -13944,21 +14007,26 @@ export interface operations {
13944
14007
  };
13945
14008
  };
13946
14009
  };
13947
- getAuditJournalDeltas: {
14010
+ getAuditEvents: {
13948
14011
  parameters: {
13949
14012
  query?: {
14013
+ cursor?: string;
13950
14014
  limit?: number;
13951
- offset?: number;
14015
+ order?: "asc" | "desc";
14016
+ /** @description Timestamp string with date, time, milliseconds, and timezone. */
14017
+ updatedFrom?: string;
14018
+ /** @description Timestamp string with date, time, milliseconds, and timezone. */
14019
+ updatedTo?: string;
14020
+ entityType?: "account" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "reservation" | "transaction";
14021
+ entityId?: string;
13952
14022
  actionId?: string;
13953
- effectId?: string;
13954
- mutationId?: string;
13955
- journalEntryId?: string;
13956
- operation?: "insert" | "update" | "delete";
13957
- rootEntityType?: string;
13958
- rootEntityId?: string;
13959
- startAt?: string;
13960
- endAt?: string;
13961
- page?: number;
14023
+ actionCode?: string;
14024
+ operation?: "create" | "update" | "delete" | "archive" | "restore" | "execute" | "recalculate";
14025
+ actorType?: "user" | "api_key" | "sync" | "automation" | "system";
14026
+ actorId?: string;
14027
+ accountingStatus?: string;
14028
+ accountId?: string;
14029
+ include?: "postingChanges";
13962
14030
  };
13963
14031
  header?: never;
13964
14032
  path?: never;
@@ -13976,50 +14044,124 @@ export interface operations {
13976
14044
  data: {
13977
14045
  /** Format: uuid */
13978
14046
  id: string;
13979
- /** Format: uuid */
13980
- tenantId: string;
13981
- /** Format: uuid */
13982
- journalEntryId: string;
14047
+ revision: number;
13983
14048
  /** Format: uuid */
13984
14049
  actionId: string;
13985
- effectId: string | null;
13986
- mutationId: string | null;
13987
- rootEntityType: string | null;
13988
- rootEntityId: string | null;
13989
- /** @enum {string} */
13990
- operation: "insert" | "update" | "delete";
14050
+ team: {
14051
+ /** Format: uuid */
14052
+ id: string;
14053
+ uniqueRef: string | null;
14054
+ name: string;
14055
+ };
13991
14056
  /**
13992
14057
  * Format: date-time
13993
14058
  * @description Timestamp string with date, time, milliseconds, and timezone.
13994
14059
  * @example 2024-01-15T12:30:00.000+00:00
13995
14060
  */
13996
- changedAt: string;
13997
- apiVersion: string;
13998
- changedFields: string[];
13999
- diffJson: unknown | null;
14000
- accountIdBefore: string | null;
14001
- accountIdAfter: string | null;
14002
- centTotalBefore: number | null;
14003
- centTotalAfter: number | null;
14004
- txnAtBefore: string | null;
14005
- txnAtAfter: string | null;
14006
- statusBefore: string | null;
14007
- statusAfter: string | null;
14008
- partyBefore: string | null;
14009
- partyAfter: string | null;
14010
- listingOwnershipPeriodIdBefore: string | null;
14011
- listingOwnershipPeriodIdAfter: string | null;
14012
- attachedToOwnerStatementIdBefore: string | null;
14013
- attachedToOwnerStatementIdAfter: string | null;
14061
+ occurredAt: string;
14062
+ /**
14063
+ * Format: date-time
14064
+ * @description Timestamp string with date, time, milliseconds, and timezone.
14065
+ * @example 2024-01-15T12:30:00.000+00:00
14066
+ */
14067
+ updatedAt: string;
14068
+ actor: {
14069
+ /** @enum {string} */
14070
+ type: "user" | "api_key" | "sync" | "automation" | "system";
14071
+ id: string | null;
14072
+ name: string | null;
14073
+ email: string | null;
14074
+ label: string | null;
14075
+ };
14076
+ source: {
14077
+ /** @enum {string} */
14078
+ type: "portal" | "api" | "integration" | "sync" | "automation" | "system";
14079
+ requestId: string | null;
14080
+ };
14081
+ action: {
14082
+ code: string;
14083
+ summary: string;
14084
+ /** @enum {string} */
14085
+ operation: "create" | "update" | "delete" | "archive" | "restore" | "execute" | "recalculate";
14086
+ };
14087
+ rootEntity: {
14088
+ /** @enum {string} */
14089
+ type: "account" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "reservation" | "transaction";
14090
+ /** Format: uuid */
14091
+ id: string;
14092
+ uniqueRef: string | null;
14093
+ name: string | null;
14094
+ };
14095
+ entityChanges: {
14096
+ entity: {
14097
+ /** @enum {string} */
14098
+ type: "account" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "reservation" | "transaction" | "paymentLine";
14099
+ /** Format: uuid */
14100
+ id: string;
14101
+ uniqueRef: string | null;
14102
+ name: string | null;
14103
+ };
14104
+ /** @enum {string} */
14105
+ operation: "create" | "update" | "delete" | "archive" | "restore" | "execute" | "recalculate";
14106
+ changes: {
14107
+ path: string;
14108
+ before?: unknown;
14109
+ after?: unknown;
14110
+ }[];
14111
+ redactedFields: string[];
14112
+ }[];
14113
+ accountingImpact: {
14114
+ /** @enum {string} */
14115
+ status: "not_applicable" | "pending" | "unchanged" | "changed" | "blocked" | "failed" | "mixed";
14116
+ changedDimensions: ("account" | "amount" | "currency" | "posting_date" | "party" | "ledger" | "status" | "ownership_period" | "owner_statement")[];
14117
+ affected: {
14118
+ accounts: {
14119
+ /** Format: uuid */
14120
+ id: string;
14121
+ name: string;
14122
+ category: {
14123
+ /** Format: uuid */
14124
+ id: string;
14125
+ name: string;
14126
+ classification: string | null;
14127
+ };
14128
+ }[];
14129
+ periods: string[];
14130
+ ownershipPeriodIds: string[];
14131
+ ownerStatementIds: string[];
14132
+ };
14133
+ postingChanges?: {
14134
+ dimensions: {
14135
+ account: {
14136
+ /** Format: uuid */
14137
+ id: string;
14138
+ name: string;
14139
+ category: {
14140
+ /** Format: uuid */
14141
+ id: string;
14142
+ name: string;
14143
+ classification: string | null;
14144
+ };
14145
+ } | null;
14146
+ party: string | null;
14147
+ currency: string | null;
14148
+ postingDate: string | null;
14149
+ ledger: string | null;
14150
+ status: string | null;
14151
+ ownershipPeriodId: string | null;
14152
+ ownerStatementId: string | null;
14153
+ };
14154
+ centTotal: {
14155
+ before: number | null;
14156
+ after: number | null;
14157
+ };
14158
+ }[];
14159
+ };
14014
14160
  }[];
14015
- pagination: {
14016
- /** @default 100 */
14161
+ page: {
14017
14162
  limit: number;
14018
- /** @default 1 */
14019
- page: number;
14020
- total: number;
14021
- totalPage: number;
14022
- nextPage?: number;
14163
+ hasMore: boolean;
14164
+ nextCursor: string | null;
14023
14165
  };
14024
14166
  };
14025
14167
  };
@@ -14149,7 +14291,7 @@ export interface operations {
14149
14291
  };
14150
14292
  };
14151
14293
  };
14152
- /** @description Gone */
14294
+ /** @description Audit cursor expired */
14153
14295
  410: {
14154
14296
  headers: {
14155
14297
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
@@ -14174,8 +14316,8 @@ export interface operations {
14174
14316
  };
14175
14317
  };
14176
14318
  };
14177
- /** @description Unprocessable content */
14178
- 422: {
14319
+ /** @description Misdirected regional request */
14320
+ 421: {
14179
14321
  headers: {
14180
14322
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14181
14323
  "Retry-After"?: number;
@@ -14199,8 +14341,8 @@ export interface operations {
14199
14341
  };
14200
14342
  };
14201
14343
  };
14202
- /** @description Internal server error */
14203
- 500: {
14344
+ /** @description Unprocessable content */
14345
+ 422: {
14204
14346
  headers: {
14205
14347
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14206
14348
  "Retry-After"?: number;
@@ -14224,8 +14366,8 @@ export interface operations {
14224
14366
  };
14225
14367
  };
14226
14368
  };
14227
- /** @description Service unavailable */
14228
- 503: {
14369
+ /** @description Rate limited */
14370
+ 429: {
14229
14371
  headers: {
14230
14372
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14231
14373
  "Retry-After"?: number;
@@ -14249,99 +14391,873 @@ export interface operations {
14249
14391
  };
14250
14392
  };
14251
14393
  };
14252
- };
14253
- };
14254
- getAuditMutations: {
14255
- parameters: {
14256
- query?: {
14257
- limit?: number;
14258
- offset?: number;
14259
- actionId?: string;
14260
- effectId?: string;
14261
- entityType?: string;
14262
- entityId?: string;
14263
- op?: string;
14264
- outcome?: string;
14265
- startAt?: string;
14266
- endAt?: string;
14267
- page?: number;
14268
- };
14269
- header?: never;
14270
- path?: never;
14271
- cookie?: never;
14272
- };
14273
- requestBody?: never;
14274
- responses: {
14275
- /** @description Successful response */
14276
- 200: {
14277
- headers: {
14278
- [name: string]: unknown;
14279
- };
14280
- content: {
14281
- "application/json": {
14282
- data: {
14283
- /** Format: uuid */
14284
- id: string;
14285
- /** Format: uuid */
14286
- tenantId: string;
14287
- /** Format: uuid */
14288
- actionId: string;
14289
- effectId: string | null;
14290
- op: string;
14291
- rootEntityType: string | null;
14292
- rootEntityId: string | null;
14293
- subjectType: string;
14294
- /** Format: uuid */
14295
- subjectId: string;
14296
- outcome: string | null;
14297
- changeRecord: {
14298
- summary: string;
14299
- changedKeys: string[];
14300
- reasonCode: string;
14301
- outcome: string;
14302
- context: {
14303
- [key: string]: unknown;
14304
- } | null;
14305
- } & {
14306
- [key: string]: unknown;
14307
- };
14308
- /**
14309
- * Format: date-time
14310
- * @description Timestamp string with date, time, milliseconds, and timezone.
14311
- * @example 2024-01-15T12:30:00.000+00:00
14312
- */
14313
- createdAt: string;
14314
- action: {
14315
- /** Format: uuid */
14316
- id: string;
14317
- actionType: string;
14318
- source: string | null;
14319
- apiVersion: string;
14320
- requestId: string | null;
14321
- traceId: string | null;
14322
- parentActionId: string | null;
14323
- actor: {
14324
- id: string | null;
14325
- type: string;
14326
- name: string | null;
14327
- email: string | null;
14328
- };
14329
- };
14330
- }[];
14331
- pagination: {
14332
- /** @default 100 */
14333
- limit: number;
14334
- /** @default 1 */
14335
- page: number;
14336
- total: number;
14337
- totalPage: number;
14338
- nextPage?: number;
14339
- };
14340
- };
14341
- };
14342
- };
14343
- /** @description Bad request */
14344
- 400: {
14394
+ /** @description Internal server error */
14395
+ 500: {
14396
+ headers: {
14397
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14398
+ "Retry-After"?: number;
14399
+ [name: string]: unknown;
14400
+ };
14401
+ content: {
14402
+ "application/json": {
14403
+ code: string;
14404
+ message: string;
14405
+ links?: {
14406
+ docs: string;
14407
+ schema: string;
14408
+ };
14409
+ issues?: {
14410
+ message: string;
14411
+ path?: (string | number)[];
14412
+ schema?: string;
14413
+ }[];
14414
+ retryable?: boolean;
14415
+ context?: unknown;
14416
+ };
14417
+ };
14418
+ };
14419
+ /** @description Service unavailable */
14420
+ 503: {
14421
+ headers: {
14422
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14423
+ "Retry-After"?: number;
14424
+ [name: string]: unknown;
14425
+ };
14426
+ content: {
14427
+ "application/json": {
14428
+ code: string;
14429
+ message: string;
14430
+ links?: {
14431
+ docs: string;
14432
+ schema: string;
14433
+ };
14434
+ issues?: {
14435
+ message: string;
14436
+ path?: (string | number)[];
14437
+ schema?: string;
14438
+ }[];
14439
+ retryable?: boolean;
14440
+ context?: unknown;
14441
+ };
14442
+ };
14443
+ };
14444
+ };
14445
+ };
14446
+ getAuditEventsById: {
14447
+ parameters: {
14448
+ query?: never;
14449
+ header?: never;
14450
+ path: {
14451
+ id: string;
14452
+ };
14453
+ cookie?: never;
14454
+ };
14455
+ requestBody?: never;
14456
+ responses: {
14457
+ /** @description Successful response */
14458
+ 200: {
14459
+ headers: {
14460
+ [name: string]: unknown;
14461
+ };
14462
+ content: {
14463
+ "application/json": {
14464
+ /** Format: uuid */
14465
+ id: string;
14466
+ revision: number;
14467
+ /** Format: uuid */
14468
+ actionId: string;
14469
+ team: {
14470
+ /** Format: uuid */
14471
+ id: string;
14472
+ uniqueRef: string | null;
14473
+ name: string;
14474
+ };
14475
+ /**
14476
+ * Format: date-time
14477
+ * @description Timestamp string with date, time, milliseconds, and timezone.
14478
+ * @example 2024-01-15T12:30:00.000+00:00
14479
+ */
14480
+ occurredAt: string;
14481
+ /**
14482
+ * Format: date-time
14483
+ * @description Timestamp string with date, time, milliseconds, and timezone.
14484
+ * @example 2024-01-15T12:30:00.000+00:00
14485
+ */
14486
+ updatedAt: string;
14487
+ actor: {
14488
+ /** @enum {string} */
14489
+ type: "user" | "api_key" | "sync" | "automation" | "system";
14490
+ id: string | null;
14491
+ name: string | null;
14492
+ email: string | null;
14493
+ label: string | null;
14494
+ };
14495
+ source: {
14496
+ /** @enum {string} */
14497
+ type: "portal" | "api" | "integration" | "sync" | "automation" | "system";
14498
+ requestId: string | null;
14499
+ };
14500
+ action: {
14501
+ code: string;
14502
+ summary: string;
14503
+ /** @enum {string} */
14504
+ operation: "create" | "update" | "delete" | "archive" | "restore" | "execute" | "recalculate";
14505
+ };
14506
+ rootEntity: {
14507
+ /** @enum {string} */
14508
+ type: "account" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "reservation" | "transaction";
14509
+ /** Format: uuid */
14510
+ id: string;
14511
+ uniqueRef: string | null;
14512
+ name: string | null;
14513
+ };
14514
+ entityChanges: {
14515
+ entity: {
14516
+ /** @enum {string} */
14517
+ type: "account" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "reservation" | "transaction" | "paymentLine";
14518
+ /** Format: uuid */
14519
+ id: string;
14520
+ uniqueRef: string | null;
14521
+ name: string | null;
14522
+ };
14523
+ /** @enum {string} */
14524
+ operation: "create" | "update" | "delete" | "archive" | "restore" | "execute" | "recalculate";
14525
+ changes: {
14526
+ path: string;
14527
+ before?: unknown;
14528
+ after?: unknown;
14529
+ }[];
14530
+ redactedFields: string[];
14531
+ }[];
14532
+ accountingImpact: {
14533
+ /** @enum {string} */
14534
+ status: "not_applicable" | "pending" | "unchanged" | "changed" | "blocked" | "failed" | "mixed";
14535
+ changedDimensions: ("account" | "amount" | "currency" | "posting_date" | "party" | "ledger" | "status" | "ownership_period" | "owner_statement")[];
14536
+ affected: {
14537
+ accounts: {
14538
+ /** Format: uuid */
14539
+ id: string;
14540
+ name: string;
14541
+ category: {
14542
+ /** Format: uuid */
14543
+ id: string;
14544
+ name: string;
14545
+ classification: string | null;
14546
+ };
14547
+ }[];
14548
+ periods: string[];
14549
+ ownershipPeriodIds: string[];
14550
+ ownerStatementIds: string[];
14551
+ };
14552
+ postingChanges: {
14553
+ dimensions: {
14554
+ account: {
14555
+ /** Format: uuid */
14556
+ id: string;
14557
+ name: string;
14558
+ category: {
14559
+ /** Format: uuid */
14560
+ id: string;
14561
+ name: string;
14562
+ classification: string | null;
14563
+ };
14564
+ } | null;
14565
+ party: string | null;
14566
+ currency: string | null;
14567
+ postingDate: string | null;
14568
+ ledger: string | null;
14569
+ status: string | null;
14570
+ ownershipPeriodId: string | null;
14571
+ ownerStatementId: string | null;
14572
+ };
14573
+ centTotal: {
14574
+ before: number | null;
14575
+ after: number | null;
14576
+ };
14577
+ }[];
14578
+ };
14579
+ };
14580
+ };
14581
+ };
14582
+ /** @description Bad request */
14583
+ 400: {
14584
+ headers: {
14585
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14586
+ "Retry-After"?: number;
14587
+ [name: string]: unknown;
14588
+ };
14589
+ content: {
14590
+ "application/json": {
14591
+ code: string;
14592
+ message: string;
14593
+ links?: {
14594
+ docs: string;
14595
+ schema: string;
14596
+ };
14597
+ issues?: {
14598
+ message: string;
14599
+ path?: (string | number)[];
14600
+ schema?: string;
14601
+ }[];
14602
+ retryable?: boolean;
14603
+ context?: unknown;
14604
+ };
14605
+ };
14606
+ };
14607
+ /** @description Unauthorized */
14608
+ 401: {
14609
+ headers: {
14610
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14611
+ "Retry-After"?: number;
14612
+ [name: string]: unknown;
14613
+ };
14614
+ content: {
14615
+ "application/json": {
14616
+ code: string;
14617
+ message: string;
14618
+ links?: {
14619
+ docs: string;
14620
+ schema: string;
14621
+ };
14622
+ issues?: {
14623
+ message: string;
14624
+ path?: (string | number)[];
14625
+ schema?: string;
14626
+ }[];
14627
+ retryable?: boolean;
14628
+ context?: unknown;
14629
+ };
14630
+ };
14631
+ };
14632
+ /** @description Forbidden */
14633
+ 403: {
14634
+ headers: {
14635
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14636
+ "Retry-After"?: number;
14637
+ [name: string]: unknown;
14638
+ };
14639
+ content: {
14640
+ "application/json": {
14641
+ code: string;
14642
+ message: string;
14643
+ links?: {
14644
+ docs: string;
14645
+ schema: string;
14646
+ };
14647
+ issues?: {
14648
+ message: string;
14649
+ path?: (string | number)[];
14650
+ schema?: string;
14651
+ }[];
14652
+ retryable?: boolean;
14653
+ context?: unknown;
14654
+ };
14655
+ };
14656
+ };
14657
+ /** @description Not found */
14658
+ 404: {
14659
+ headers: {
14660
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14661
+ "Retry-After"?: number;
14662
+ [name: string]: unknown;
14663
+ };
14664
+ content: {
14665
+ "application/json": {
14666
+ code: string;
14667
+ message: string;
14668
+ links?: {
14669
+ docs: string;
14670
+ schema: string;
14671
+ };
14672
+ issues?: {
14673
+ message: string;
14674
+ path?: (string | number)[];
14675
+ schema?: string;
14676
+ }[];
14677
+ retryable?: boolean;
14678
+ context?: unknown;
14679
+ };
14680
+ };
14681
+ };
14682
+ /** @description Conflict */
14683
+ 409: {
14684
+ headers: {
14685
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14686
+ "Retry-After"?: number;
14687
+ [name: string]: unknown;
14688
+ };
14689
+ content: {
14690
+ "application/json": {
14691
+ code: string;
14692
+ message: string;
14693
+ links?: {
14694
+ docs: string;
14695
+ schema: string;
14696
+ };
14697
+ issues?: {
14698
+ message: string;
14699
+ path?: (string | number)[];
14700
+ schema?: string;
14701
+ }[];
14702
+ retryable?: boolean;
14703
+ context?: unknown;
14704
+ };
14705
+ };
14706
+ };
14707
+ /** @description Gone */
14708
+ 410: {
14709
+ headers: {
14710
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14711
+ "Retry-After"?: number;
14712
+ [name: string]: unknown;
14713
+ };
14714
+ content: {
14715
+ "application/json": {
14716
+ code: string;
14717
+ message: string;
14718
+ links?: {
14719
+ docs: string;
14720
+ schema: string;
14721
+ };
14722
+ issues?: {
14723
+ message: string;
14724
+ path?: (string | number)[];
14725
+ schema?: string;
14726
+ }[];
14727
+ retryable?: boolean;
14728
+ context?: unknown;
14729
+ };
14730
+ };
14731
+ };
14732
+ /** @description Misdirected regional request */
14733
+ 421: {
14734
+ headers: {
14735
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14736
+ "Retry-After"?: number;
14737
+ [name: string]: unknown;
14738
+ };
14739
+ content: {
14740
+ "application/json": {
14741
+ code: string;
14742
+ message: string;
14743
+ links?: {
14744
+ docs: string;
14745
+ schema: string;
14746
+ };
14747
+ issues?: {
14748
+ message: string;
14749
+ path?: (string | number)[];
14750
+ schema?: string;
14751
+ }[];
14752
+ retryable?: boolean;
14753
+ context?: unknown;
14754
+ };
14755
+ };
14756
+ };
14757
+ /** @description Unprocessable content */
14758
+ 422: {
14759
+ headers: {
14760
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14761
+ "Retry-After"?: number;
14762
+ [name: string]: unknown;
14763
+ };
14764
+ content: {
14765
+ "application/json": {
14766
+ code: string;
14767
+ message: string;
14768
+ links?: {
14769
+ docs: string;
14770
+ schema: string;
14771
+ };
14772
+ issues?: {
14773
+ message: string;
14774
+ path?: (string | number)[];
14775
+ schema?: string;
14776
+ }[];
14777
+ retryable?: boolean;
14778
+ context?: unknown;
14779
+ };
14780
+ };
14781
+ };
14782
+ /** @description Rate limited */
14783
+ 429: {
14784
+ headers: {
14785
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14786
+ "Retry-After"?: number;
14787
+ [name: string]: unknown;
14788
+ };
14789
+ content: {
14790
+ "application/json": {
14791
+ code: string;
14792
+ message: string;
14793
+ links?: {
14794
+ docs: string;
14795
+ schema: string;
14796
+ };
14797
+ issues?: {
14798
+ message: string;
14799
+ path?: (string | number)[];
14800
+ schema?: string;
14801
+ }[];
14802
+ retryable?: boolean;
14803
+ context?: unknown;
14804
+ };
14805
+ };
14806
+ };
14807
+ /** @description Internal server error */
14808
+ 500: {
14809
+ headers: {
14810
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14811
+ "Retry-After"?: number;
14812
+ [name: string]: unknown;
14813
+ };
14814
+ content: {
14815
+ "application/json": {
14816
+ code: string;
14817
+ message: string;
14818
+ links?: {
14819
+ docs: string;
14820
+ schema: string;
14821
+ };
14822
+ issues?: {
14823
+ message: string;
14824
+ path?: (string | number)[];
14825
+ schema?: string;
14826
+ }[];
14827
+ retryable?: boolean;
14828
+ context?: unknown;
14829
+ };
14830
+ };
14831
+ };
14832
+ /** @description Service unavailable */
14833
+ 503: {
14834
+ headers: {
14835
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14836
+ "Retry-After"?: number;
14837
+ [name: string]: unknown;
14838
+ };
14839
+ content: {
14840
+ "application/json": {
14841
+ code: string;
14842
+ message: string;
14843
+ links?: {
14844
+ docs: string;
14845
+ schema: string;
14846
+ };
14847
+ issues?: {
14848
+ message: string;
14849
+ path?: (string | number)[];
14850
+ schema?: string;
14851
+ }[];
14852
+ retryable?: boolean;
14853
+ context?: unknown;
14854
+ };
14855
+ };
14856
+ };
14857
+ };
14858
+ };
14859
+ getAuditJournalDeltas: {
14860
+ parameters: {
14861
+ query?: {
14862
+ limit?: number;
14863
+ offset?: number;
14864
+ actionId?: string;
14865
+ effectId?: string;
14866
+ mutationId?: string;
14867
+ journalEntryId?: string;
14868
+ operation?: "insert" | "update" | "delete";
14869
+ rootEntityType?: string;
14870
+ rootEntityId?: string;
14871
+ startAt?: string;
14872
+ endAt?: string;
14873
+ page?: number;
14874
+ };
14875
+ header?: never;
14876
+ path?: never;
14877
+ cookie?: never;
14878
+ };
14879
+ requestBody?: never;
14880
+ responses: {
14881
+ /** @description Successful response */
14882
+ 200: {
14883
+ headers: {
14884
+ [name: string]: unknown;
14885
+ };
14886
+ content: {
14887
+ "application/json": {
14888
+ data: {
14889
+ /** Format: uuid */
14890
+ id: string;
14891
+ /** Format: uuid */
14892
+ tenantId: string;
14893
+ /** Format: uuid */
14894
+ journalEntryId: string;
14895
+ /** Format: uuid */
14896
+ actionId: string;
14897
+ effectId: string | null;
14898
+ mutationId: string | null;
14899
+ rootEntityType: string | null;
14900
+ rootEntityId: string | null;
14901
+ /** @enum {string} */
14902
+ operation: "insert" | "update" | "delete";
14903
+ /**
14904
+ * Format: date-time
14905
+ * @description Timestamp string with date, time, milliseconds, and timezone.
14906
+ * @example 2024-01-15T12:30:00.000+00:00
14907
+ */
14908
+ changedAt: string;
14909
+ apiVersion: string;
14910
+ changedFields: string[];
14911
+ diffJson: unknown | null;
14912
+ accountIdBefore: string | null;
14913
+ accountIdAfter: string | null;
14914
+ centTotalBefore: number | null;
14915
+ centTotalAfter: number | null;
14916
+ currencyBefore: string | null;
14917
+ currencyAfter: string | null;
14918
+ ledgerBefore: string | null;
14919
+ ledgerAfter: string | null;
14920
+ txnAtBefore: string | null;
14921
+ txnAtAfter: string | null;
14922
+ statusBefore: string | null;
14923
+ statusAfter: string | null;
14924
+ partyBefore: string | null;
14925
+ partyAfter: string | null;
14926
+ listingOwnershipPeriodIdBefore: string | null;
14927
+ listingOwnershipPeriodIdAfter: string | null;
14928
+ attachedToOwnerStatementIdBefore: string | null;
14929
+ attachedToOwnerStatementIdAfter: string | null;
14930
+ }[];
14931
+ pagination: {
14932
+ /** @default 100 */
14933
+ limit: number;
14934
+ /** @default 1 */
14935
+ page: number;
14936
+ total: number;
14937
+ totalPage: number;
14938
+ nextPage?: number;
14939
+ };
14940
+ };
14941
+ };
14942
+ };
14943
+ /** @description Bad request */
14944
+ 400: {
14945
+ headers: {
14946
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14947
+ "Retry-After"?: number;
14948
+ [name: string]: unknown;
14949
+ };
14950
+ content: {
14951
+ "application/json": {
14952
+ code: string;
14953
+ message: string;
14954
+ links?: {
14955
+ docs: string;
14956
+ schema: string;
14957
+ };
14958
+ issues?: {
14959
+ message: string;
14960
+ path?: (string | number)[];
14961
+ schema?: string;
14962
+ }[];
14963
+ retryable?: boolean;
14964
+ context?: unknown;
14965
+ };
14966
+ };
14967
+ };
14968
+ /** @description Unauthorized */
14969
+ 401: {
14970
+ headers: {
14971
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14972
+ "Retry-After"?: number;
14973
+ [name: string]: unknown;
14974
+ };
14975
+ content: {
14976
+ "application/json": {
14977
+ code: string;
14978
+ message: string;
14979
+ links?: {
14980
+ docs: string;
14981
+ schema: string;
14982
+ };
14983
+ issues?: {
14984
+ message: string;
14985
+ path?: (string | number)[];
14986
+ schema?: string;
14987
+ }[];
14988
+ retryable?: boolean;
14989
+ context?: unknown;
14990
+ };
14991
+ };
14992
+ };
14993
+ /** @description Forbidden */
14994
+ 403: {
14995
+ headers: {
14996
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14997
+ "Retry-After"?: number;
14998
+ [name: string]: unknown;
14999
+ };
15000
+ content: {
15001
+ "application/json": {
15002
+ code: string;
15003
+ message: string;
15004
+ links?: {
15005
+ docs: string;
15006
+ schema: string;
15007
+ };
15008
+ issues?: {
15009
+ message: string;
15010
+ path?: (string | number)[];
15011
+ schema?: string;
15012
+ }[];
15013
+ retryable?: boolean;
15014
+ context?: unknown;
15015
+ };
15016
+ };
15017
+ };
15018
+ /** @description Not found */
15019
+ 404: {
15020
+ headers: {
15021
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
15022
+ "Retry-After"?: number;
15023
+ [name: string]: unknown;
15024
+ };
15025
+ content: {
15026
+ "application/json": {
15027
+ code: string;
15028
+ message: string;
15029
+ links?: {
15030
+ docs: string;
15031
+ schema: string;
15032
+ };
15033
+ issues?: {
15034
+ message: string;
15035
+ path?: (string | number)[];
15036
+ schema?: string;
15037
+ }[];
15038
+ retryable?: boolean;
15039
+ context?: unknown;
15040
+ };
15041
+ };
15042
+ };
15043
+ /** @description Conflict */
15044
+ 409: {
15045
+ headers: {
15046
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
15047
+ "Retry-After"?: number;
15048
+ [name: string]: unknown;
15049
+ };
15050
+ content: {
15051
+ "application/json": {
15052
+ code: string;
15053
+ message: string;
15054
+ links?: {
15055
+ docs: string;
15056
+ schema: string;
15057
+ };
15058
+ issues?: {
15059
+ message: string;
15060
+ path?: (string | number)[];
15061
+ schema?: string;
15062
+ }[];
15063
+ retryable?: boolean;
15064
+ context?: unknown;
15065
+ };
15066
+ };
15067
+ };
15068
+ /** @description Gone */
15069
+ 410: {
15070
+ headers: {
15071
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
15072
+ "Retry-After"?: number;
15073
+ [name: string]: unknown;
15074
+ };
15075
+ content: {
15076
+ "application/json": {
15077
+ code: string;
15078
+ message: string;
15079
+ links?: {
15080
+ docs: string;
15081
+ schema: string;
15082
+ };
15083
+ issues?: {
15084
+ message: string;
15085
+ path?: (string | number)[];
15086
+ schema?: string;
15087
+ }[];
15088
+ retryable?: boolean;
15089
+ context?: unknown;
15090
+ };
15091
+ };
15092
+ };
15093
+ /** @description Unprocessable content */
15094
+ 422: {
15095
+ headers: {
15096
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
15097
+ "Retry-After"?: number;
15098
+ [name: string]: unknown;
15099
+ };
15100
+ content: {
15101
+ "application/json": {
15102
+ code: string;
15103
+ message: string;
15104
+ links?: {
15105
+ docs: string;
15106
+ schema: string;
15107
+ };
15108
+ issues?: {
15109
+ message: string;
15110
+ path?: (string | number)[];
15111
+ schema?: string;
15112
+ }[];
15113
+ retryable?: boolean;
15114
+ context?: unknown;
15115
+ };
15116
+ };
15117
+ };
15118
+ /** @description Internal server error */
15119
+ 500: {
15120
+ headers: {
15121
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
15122
+ "Retry-After"?: number;
15123
+ [name: string]: unknown;
15124
+ };
15125
+ content: {
15126
+ "application/json": {
15127
+ code: string;
15128
+ message: string;
15129
+ links?: {
15130
+ docs: string;
15131
+ schema: string;
15132
+ };
15133
+ issues?: {
15134
+ message: string;
15135
+ path?: (string | number)[];
15136
+ schema?: string;
15137
+ }[];
15138
+ retryable?: boolean;
15139
+ context?: unknown;
15140
+ };
15141
+ };
15142
+ };
15143
+ /** @description Service unavailable */
15144
+ 503: {
15145
+ headers: {
15146
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
15147
+ "Retry-After"?: number;
15148
+ [name: string]: unknown;
15149
+ };
15150
+ content: {
15151
+ "application/json": {
15152
+ code: string;
15153
+ message: string;
15154
+ links?: {
15155
+ docs: string;
15156
+ schema: string;
15157
+ };
15158
+ issues?: {
15159
+ message: string;
15160
+ path?: (string | number)[];
15161
+ schema?: string;
15162
+ }[];
15163
+ retryable?: boolean;
15164
+ context?: unknown;
15165
+ };
15166
+ };
15167
+ };
15168
+ };
15169
+ };
15170
+ getAuditMutations: {
15171
+ parameters: {
15172
+ query?: {
15173
+ limit?: number;
15174
+ offset?: number;
15175
+ actionId?: string;
15176
+ effectId?: string;
15177
+ entityType?: string;
15178
+ entityId?: string;
15179
+ op?: string;
15180
+ outcome?: string;
15181
+ startAt?: string;
15182
+ endAt?: string;
15183
+ page?: number;
15184
+ };
15185
+ header?: never;
15186
+ path?: never;
15187
+ cookie?: never;
15188
+ };
15189
+ requestBody?: never;
15190
+ responses: {
15191
+ /** @description Successful response */
15192
+ 200: {
15193
+ headers: {
15194
+ [name: string]: unknown;
15195
+ };
15196
+ content: {
15197
+ "application/json": {
15198
+ data: {
15199
+ /** Format: uuid */
15200
+ id: string;
15201
+ /** Format: uuid */
15202
+ tenantId: string;
15203
+ /** Format: uuid */
15204
+ actionId: string;
15205
+ effectId: string | null;
15206
+ op: string;
15207
+ rootEntityType: string | null;
15208
+ rootEntityId: string | null;
15209
+ subjectType: string;
15210
+ /** Format: uuid */
15211
+ subjectId: string;
15212
+ outcome: string | null;
15213
+ changeRecord: {
15214
+ summary: string;
15215
+ changedKeys: string[];
15216
+ reasonCode: string;
15217
+ outcome: string;
15218
+ context: {
15219
+ [key: string]: unknown;
15220
+ } | null;
15221
+ } & {
15222
+ [key: string]: unknown;
15223
+ };
15224
+ /**
15225
+ * Format: date-time
15226
+ * @description Timestamp string with date, time, milliseconds, and timezone.
15227
+ * @example 2024-01-15T12:30:00.000+00:00
15228
+ */
15229
+ createdAt: string;
15230
+ action: {
15231
+ /** Format: uuid */
15232
+ id: string;
15233
+ actionType: string;
15234
+ source: string | null;
15235
+ apiVersion: string;
15236
+ requestId: string | null;
15237
+ traceId: string | null;
15238
+ parentActionId: string | null;
15239
+ actor: {
15240
+ id: string | null;
15241
+ type: string;
15242
+ name: string | null;
15243
+ email: string | null;
15244
+ };
15245
+ };
15246
+ }[];
15247
+ pagination: {
15248
+ /** @default 100 */
15249
+ limit: number;
15250
+ /** @default 1 */
15251
+ page: number;
15252
+ total: number;
15253
+ totalPage: number;
15254
+ nextPage?: number;
15255
+ };
15256
+ };
15257
+ };
15258
+ };
15259
+ /** @description Bad request */
15260
+ 400: {
14345
15261
  headers: {
14346
15262
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
14347
15263
  "Retry-After"?: number;
@@ -38880,6 +39796,9 @@ export interface operations {
38880
39796
  investigatedHomepageUrl: string | null;
38881
39797
  investigatedDomain: string | null;
38882
39798
  error: string;
39799
+ context?: {
39800
+ [key: string]: unknown;
39801
+ };
38883
39802
  }[];
38884
39803
  };
38885
39804
  };
@@ -56255,9 +57174,273 @@ export interface operations {
56255
57174
  };
56256
57175
  };
56257
57176
  };
56258
- getMetricFutureBookedRevenue: {
57177
+ getMetricFutureBookedRevenue: {
57178
+ parameters: {
57179
+ query?: {
57180
+ interval?: "month" | "week" | "day" | "year";
57181
+ /** @description Deprecated: use interval */
57182
+ dimension?: "month" | "week" | "day" | "year";
57183
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
57184
+ startDate?: string;
57185
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
57186
+ endDate?: string;
57187
+ /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
57188
+ dateRange?: string;
57189
+ /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
57190
+ isDateRangeEndInclusive?: boolean;
57191
+ };
57192
+ header?: never;
57193
+ path?: never;
57194
+ cookie?: never;
57195
+ };
57196
+ requestBody?: never;
57197
+ responses: {
57198
+ /** @description Successful response */
57199
+ 200: {
57200
+ headers: {
57201
+ [name: string]: unknown;
57202
+ };
57203
+ content: {
57204
+ "application/json": {
57205
+ data: {
57206
+ date: string;
57207
+ futureRevenue: number;
57208
+ bookedRevenue: number;
57209
+ }[];
57210
+ };
57211
+ };
57212
+ };
57213
+ /** @description Bad request */
57214
+ 400: {
57215
+ headers: {
57216
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
57217
+ "Retry-After"?: number;
57218
+ [name: string]: unknown;
57219
+ };
57220
+ content: {
57221
+ "application/json": {
57222
+ code: string;
57223
+ message: string;
57224
+ links?: {
57225
+ docs: string;
57226
+ schema: string;
57227
+ };
57228
+ issues?: {
57229
+ message: string;
57230
+ path?: (string | number)[];
57231
+ schema?: string;
57232
+ }[];
57233
+ retryable?: boolean;
57234
+ context?: unknown;
57235
+ };
57236
+ };
57237
+ };
57238
+ /** @description Unauthorized */
57239
+ 401: {
57240
+ headers: {
57241
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
57242
+ "Retry-After"?: number;
57243
+ [name: string]: unknown;
57244
+ };
57245
+ content: {
57246
+ "application/json": {
57247
+ code: string;
57248
+ message: string;
57249
+ links?: {
57250
+ docs: string;
57251
+ schema: string;
57252
+ };
57253
+ issues?: {
57254
+ message: string;
57255
+ path?: (string | number)[];
57256
+ schema?: string;
57257
+ }[];
57258
+ retryable?: boolean;
57259
+ context?: unknown;
57260
+ };
57261
+ };
57262
+ };
57263
+ /** @description Forbidden */
57264
+ 403: {
57265
+ headers: {
57266
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
57267
+ "Retry-After"?: number;
57268
+ [name: string]: unknown;
57269
+ };
57270
+ content: {
57271
+ "application/json": {
57272
+ code: string;
57273
+ message: string;
57274
+ links?: {
57275
+ docs: string;
57276
+ schema: string;
57277
+ };
57278
+ issues?: {
57279
+ message: string;
57280
+ path?: (string | number)[];
57281
+ schema?: string;
57282
+ }[];
57283
+ retryable?: boolean;
57284
+ context?: unknown;
57285
+ };
57286
+ };
57287
+ };
57288
+ /** @description Not found */
57289
+ 404: {
57290
+ headers: {
57291
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
57292
+ "Retry-After"?: number;
57293
+ [name: string]: unknown;
57294
+ };
57295
+ content: {
57296
+ "application/json": {
57297
+ code: string;
57298
+ message: string;
57299
+ links?: {
57300
+ docs: string;
57301
+ schema: string;
57302
+ };
57303
+ issues?: {
57304
+ message: string;
57305
+ path?: (string | number)[];
57306
+ schema?: string;
57307
+ }[];
57308
+ retryable?: boolean;
57309
+ context?: unknown;
57310
+ };
57311
+ };
57312
+ };
57313
+ /** @description Conflict */
57314
+ 409: {
57315
+ headers: {
57316
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
57317
+ "Retry-After"?: number;
57318
+ [name: string]: unknown;
57319
+ };
57320
+ content: {
57321
+ "application/json": {
57322
+ code: string;
57323
+ message: string;
57324
+ links?: {
57325
+ docs: string;
57326
+ schema: string;
57327
+ };
57328
+ issues?: {
57329
+ message: string;
57330
+ path?: (string | number)[];
57331
+ schema?: string;
57332
+ }[];
57333
+ retryable?: boolean;
57334
+ context?: unknown;
57335
+ };
57336
+ };
57337
+ };
57338
+ /** @description Gone */
57339
+ 410: {
57340
+ headers: {
57341
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
57342
+ "Retry-After"?: number;
57343
+ [name: string]: unknown;
57344
+ };
57345
+ content: {
57346
+ "application/json": {
57347
+ code: string;
57348
+ message: string;
57349
+ links?: {
57350
+ docs: string;
57351
+ schema: string;
57352
+ };
57353
+ issues?: {
57354
+ message: string;
57355
+ path?: (string | number)[];
57356
+ schema?: string;
57357
+ }[];
57358
+ retryable?: boolean;
57359
+ context?: unknown;
57360
+ };
57361
+ };
57362
+ };
57363
+ /** @description Unprocessable content */
57364
+ 422: {
57365
+ headers: {
57366
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
57367
+ "Retry-After"?: number;
57368
+ [name: string]: unknown;
57369
+ };
57370
+ content: {
57371
+ "application/json": {
57372
+ code: string;
57373
+ message: string;
57374
+ links?: {
57375
+ docs: string;
57376
+ schema: string;
57377
+ };
57378
+ issues?: {
57379
+ message: string;
57380
+ path?: (string | number)[];
57381
+ schema?: string;
57382
+ }[];
57383
+ retryable?: boolean;
57384
+ context?: unknown;
57385
+ };
57386
+ };
57387
+ };
57388
+ /** @description Internal server error */
57389
+ 500: {
57390
+ headers: {
57391
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
57392
+ "Retry-After"?: number;
57393
+ [name: string]: unknown;
57394
+ };
57395
+ content: {
57396
+ "application/json": {
57397
+ code: string;
57398
+ message: string;
57399
+ links?: {
57400
+ docs: string;
57401
+ schema: string;
57402
+ };
57403
+ issues?: {
57404
+ message: string;
57405
+ path?: (string | number)[];
57406
+ schema?: string;
57407
+ }[];
57408
+ retryable?: boolean;
57409
+ context?: unknown;
57410
+ };
57411
+ };
57412
+ };
57413
+ /** @description Service unavailable */
57414
+ 503: {
57415
+ headers: {
57416
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
57417
+ "Retry-After"?: number;
57418
+ [name: string]: unknown;
57419
+ };
57420
+ content: {
57421
+ "application/json": {
57422
+ code: string;
57423
+ message: string;
57424
+ links?: {
57425
+ docs: string;
57426
+ schema: string;
57427
+ };
57428
+ issues?: {
57429
+ message: string;
57430
+ path?: (string | number)[];
57431
+ schema?: string;
57432
+ }[];
57433
+ retryable?: boolean;
57434
+ context?: unknown;
57435
+ };
57436
+ };
57437
+ };
57438
+ };
57439
+ };
57440
+ getMetricJournalEntryTotalsByRecurringFee: {
56259
57441
  parameters: {
56260
- query?: {
57442
+ query: {
57443
+ recurringFeeId: string;
56261
57444
  interval?: "month" | "week" | "day" | "year";
56262
57445
  /** @description Deprecated: use interval */
56263
57446
  dimension?: "month" | "week" | "day" | "year";
@@ -56285,8 +57468,8 @@ export interface operations {
56285
57468
  "application/json": {
56286
57469
  data: {
56287
57470
  date: string;
56288
- futureRevenue: number;
56289
- bookedRevenue: number;
57471
+ count: number;
57472
+ amount: number;
56290
57473
  }[];
56291
57474
  };
56292
57475
  };
@@ -56518,10 +57701,9 @@ export interface operations {
56518
57701
  };
56519
57702
  };
56520
57703
  };
56521
- getMetricJournalEntryTotalsByRecurringFee: {
57704
+ getMetricLegacyActiveListingCreated: {
56522
57705
  parameters: {
56523
- query: {
56524
- recurringFeeId: string;
57706
+ query?: {
56525
57707
  interval?: "month" | "week" | "day" | "year";
56526
57708
  /** @description Deprecated: use interval */
56527
57709
  dimension?: "month" | "week" | "day" | "year";
@@ -56549,8 +57731,7 @@ export interface operations {
56549
57731
  "application/json": {
56550
57732
  data: {
56551
57733
  date: string;
56552
- count: number;
56553
- amount: number;
57734
+ created: number;
56554
57735
  }[];
56555
57736
  };
56556
57737
  };
@@ -56782,12 +57963,9 @@ export interface operations {
56782
57963
  };
56783
57964
  };
56784
57965
  };
56785
- getMetricLegacyActiveListingCreated: {
57966
+ getMetricLegacyCurrencies: {
56786
57967
  parameters: {
56787
57968
  query?: {
56788
- interval?: "month" | "week" | "day" | "year";
56789
- /** @description Deprecated: use interval */
56790
- dimension?: "month" | "week" | "day" | "year";
56791
57969
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
56792
57970
  startDate?: string;
56793
57971
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
@@ -56811,8 +57989,7 @@ export interface operations {
56811
57989
  content: {
56812
57990
  "application/json": {
56813
57991
  data: {
56814
- date: string;
56815
- created: number;
57992
+ currency: string | null;
56816
57993
  }[];
56817
57994
  };
56818
57995
  };
@@ -57044,9 +58221,12 @@ export interface operations {
57044
58221
  };
57045
58222
  };
57046
58223
  };
57047
- getMetricLegacyCurrencies: {
58224
+ getMetricLegacyPaymentVolume: {
57048
58225
  parameters: {
57049
58226
  query?: {
58227
+ interval?: "month" | "week" | "day" | "year";
58228
+ /** @description Deprecated: use interval */
58229
+ dimension?: "month" | "week" | "day" | "year";
57050
58230
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
57051
58231
  startDate?: string;
57052
58232
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
@@ -57070,6 +58250,9 @@ export interface operations {
57070
58250
  content: {
57071
58251
  "application/json": {
57072
58252
  data: {
58253
+ date: string;
58254
+ /** @description Decimal value in dollars (major currency units) */
58255
+ total: number;
57073
58256
  currency: string | null;
57074
58257
  }[];
57075
58258
  };
@@ -57302,7 +58485,7 @@ export interface operations {
57302
58485
  };
57303
58486
  };
57304
58487
  };
57305
- getMetricLegacyPaymentVolume: {
58488
+ getMetricLegacyReservationDailyRate: {
57306
58489
  parameters: {
57307
58490
  query?: {
57308
58491
  interval?: "month" | "week" | "day" | "year";
@@ -57332,8 +58515,7 @@ export interface operations {
57332
58515
  "application/json": {
57333
58516
  data: {
57334
58517
  date: string;
57335
- /** @description Decimal value in dollars (major currency units) */
57336
- total: number;
58518
+ rate: number;
57337
58519
  currency: string | null;
57338
58520
  }[];
57339
58521
  };
@@ -57566,7 +58748,7 @@ export interface operations {
57566
58748
  };
57567
58749
  };
57568
58750
  };
57569
- getMetricLegacyReservationDailyRate: {
58751
+ getMetricLegacyReservationVolume: {
57570
58752
  parameters: {
57571
58753
  query?: {
57572
58754
  interval?: "month" | "week" | "day" | "year";
@@ -57596,7 +58778,8 @@ export interface operations {
57596
58778
  "application/json": {
57597
58779
  data: {
57598
58780
  date: string;
57599
- rate: number;
58781
+ /** @description Decimal value in dollars (major currency units) */
58782
+ total: number;
57600
58783
  currency: string | null;
57601
58784
  }[];
57602
58785
  };
@@ -57829,9 +59012,11 @@ export interface operations {
57829
59012
  };
57830
59013
  };
57831
59014
  };
57832
- getMetricLegacyReservationVolume: {
59015
+ getMetricListingRevenue: {
57833
59016
  parameters: {
57834
- query?: {
59017
+ query: {
59018
+ listingId: string;
59019
+ party: "owners" | "manager";
57835
59020
  interval?: "month" | "week" | "day" | "year";
57836
59021
  /** @description Deprecated: use interval */
57837
59022
  dimension?: "month" | "week" | "day" | "year";
@@ -57859,9 +59044,10 @@ export interface operations {
57859
59044
  "application/json": {
57860
59045
  data: {
57861
59046
  date: string;
57862
- /** @description Decimal value in dollars (major currency units) */
57863
- total: number;
57864
- currency: string | null;
59047
+ lockedRevenue?: number;
59048
+ unlockedRevenue: number;
59049
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
59050
+ currency: string;
57865
59051
  }[];
57866
59052
  };
57867
59053
  };
@@ -58093,11 +59279,9 @@ export interface operations {
58093
59279
  };
58094
59280
  };
58095
59281
  };
58096
- getMetricListingRevenue: {
59282
+ getMetricOccupancyRateOverTime: {
58097
59283
  parameters: {
58098
- query: {
58099
- listingId: string;
58100
- party: "owners" | "manager";
59284
+ query?: {
58101
59285
  interval?: "month" | "week" | "day" | "year";
58102
59286
  /** @description Deprecated: use interval */
58103
59287
  dimension?: "month" | "week" | "day" | "year";
@@ -58125,10 +59309,9 @@ export interface operations {
58125
59309
  "application/json": {
58126
59310
  data: {
58127
59311
  date: string;
58128
- lockedRevenue?: number;
58129
- unlockedRevenue: number;
58130
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
58131
- currency: string;
59312
+ occupiedNights: number;
59313
+ availableNights: number;
59314
+ occupancyRate: number;
58132
59315
  }[];
58133
59316
  };
58134
59317
  };
@@ -58360,12 +59543,10 @@ export interface operations {
58360
59543
  };
58361
59544
  };
58362
59545
  };
58363
- getMetricOccupancyRateOverTime: {
59546
+ getMetricOwnerRevenue: {
58364
59547
  parameters: {
58365
- query?: {
58366
- interval?: "month" | "week" | "day" | "year";
58367
- /** @description Deprecated: use interval */
58368
- dimension?: "month" | "week" | "day" | "year";
59548
+ query: {
59549
+ ownerId: string;
58369
59550
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
58370
59551
  startDate?: string;
58371
59552
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
@@ -58374,6 +59555,8 @@ export interface operations {
58374
59555
  dateRange?: string;
58375
59556
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
58376
59557
  isDateRangeEndInclusive?: boolean;
59558
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
59559
+ currency?: string;
58377
59560
  };
58378
59561
  header?: never;
58379
59562
  path?: never;
@@ -58390,9 +59573,8 @@ export interface operations {
58390
59573
  "application/json": {
58391
59574
  data: {
58392
59575
  date: string;
58393
- occupiedNights: number;
58394
- availableNights: number;
58395
- occupancyRate: number;
59576
+ lockedRevenue: number;
59577
+ unlockedRevenue: number;
58396
59578
  }[];
58397
59579
  };
58398
59580
  };
@@ -58624,10 +59806,9 @@ export interface operations {
58624
59806
  };
58625
59807
  };
58626
59808
  };
58627
- getMetricOwnerRevenue: {
59809
+ getMetricReservationCount: {
58628
59810
  parameters: {
58629
- query: {
58630
- ownerId: string;
59811
+ query?: {
58631
59812
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
58632
59813
  startDate?: string;
58633
59814
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
@@ -58636,8 +59817,6 @@ export interface operations {
58636
59817
  dateRange?: string;
58637
59818
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
58638
59819
  isDateRangeEndInclusive?: boolean;
58639
- /** @description Currency in ISO 4217 format, will be converted to lowercase */
58640
- currency?: string;
58641
59820
  };
58642
59821
  header?: never;
58643
59822
  path?: never;
@@ -58653,9 +59832,10 @@ export interface operations {
58653
59832
  content: {
58654
59833
  "application/json": {
58655
59834
  data: {
58656
- date: string;
58657
- lockedRevenue: number;
58658
- unlockedRevenue: number;
59835
+ current: number;
59836
+ previous: number;
59837
+ delta: number;
59838
+ deltaPercentage: number | null;
58659
59839
  }[];
58660
59840
  };
58661
59841
  };
@@ -58887,13 +60067,12 @@ export interface operations {
58887
60067
  };
58888
60068
  };
58889
60069
  };
58890
- getMetricReservationCount: {
60070
+ getMetricReservationVolume: {
58891
60071
  parameters: {
58892
60072
  query?: {
58893
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
58894
- startDate?: string;
58895
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
58896
- endDate?: string;
60073
+ interval?: "month" | "week" | "day" | "year";
60074
+ /** @description Deprecated: use interval */
60075
+ dimension?: "month" | "week" | "day" | "year";
58897
60076
  /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
58898
60077
  dateRange?: string;
58899
60078
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
@@ -58913,10 +60092,10 @@ export interface operations {
58913
60092
  content: {
58914
60093
  "application/json": {
58915
60094
  data: {
58916
- current: number;
58917
- previous: number;
58918
- delta: number;
58919
- deltaPercentage: number | null;
60095
+ currency: string | null;
60096
+ date: string;
60097
+ /** @description Decimal value in dollars (major currency units) */
60098
+ amount: number;
58920
60099
  }[];
58921
60100
  };
58922
60101
  };
@@ -59148,12 +60327,16 @@ export interface operations {
59148
60327
  };
59149
60328
  };
59150
60329
  };
59151
- getMetricReservationVolume: {
60330
+ getMetricRevenue: {
59152
60331
  parameters: {
59153
60332
  query?: {
59154
60333
  interval?: "month" | "week" | "day" | "year";
59155
60334
  /** @description Deprecated: use interval */
59156
60335
  dimension?: "month" | "week" | "day" | "year";
60336
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
60337
+ startDate?: string;
60338
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
60339
+ endDate?: string;
59157
60340
  /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
59158
60341
  dateRange?: string;
59159
60342
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
@@ -59173,10 +60356,9 @@ export interface operations {
59173
60356
  content: {
59174
60357
  "application/json": {
59175
60358
  data: {
59176
- currency: string | null;
59177
60359
  date: string;
59178
- /** @description Decimal value in dollars (major currency units) */
59179
- amount: number;
60360
+ grossGuestRevenue: number;
60361
+ pmRevenue: number;
59180
60362
  }[];
59181
60363
  };
59182
60364
  };
@@ -59408,16 +60590,14 @@ export interface operations {
59408
60590
  };
59409
60591
  };
59410
60592
  };
59411
- getMetricRevenue: {
60593
+ getSyncMetricsByStatus: {
59412
60594
  parameters: {
59413
- query?: {
60595
+ query: {
59414
60596
  interval?: "month" | "week" | "day" | "year";
59415
60597
  /** @description Deprecated: use interval */
59416
60598
  dimension?: "month" | "week" | "day" | "year";
59417
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
59418
- startDate?: string;
59419
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
59420
- endDate?: string;
60599
+ connectionId: string;
60600
+ view: "automate" | "extract";
59421
60601
  /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
59422
60602
  dateRange?: string;
59423
60603
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
@@ -59438,8 +60618,21 @@ export interface operations {
59438
60618
  "application/json": {
59439
60619
  data: {
59440
60620
  date: string;
59441
- grossGuestRevenue: number;
59442
- pmRevenue: number;
60621
+ total: number;
60622
+ changes: {
60623
+ completed?: {
60624
+ [key: string]: number;
60625
+ };
60626
+ skipped?: {
60627
+ [key: string]: number;
60628
+ };
60629
+ failed?: {
60630
+ [key: string]: number;
60631
+ };
60632
+ queued?: {
60633
+ [key: string]: number;
60634
+ };
60635
+ };
59443
60636
  }[];
59444
60637
  };
59445
60638
  };
@@ -59671,14 +60864,16 @@ export interface operations {
59671
60864
  };
59672
60865
  };
59673
60866
  };
59674
- getSyncMetricsByStatus: {
60867
+ getMetricTakeRate: {
59675
60868
  parameters: {
59676
- query: {
60869
+ query?: {
59677
60870
  interval?: "month" | "week" | "day" | "year";
59678
60871
  /** @description Deprecated: use interval */
59679
60872
  dimension?: "month" | "week" | "day" | "year";
59680
- connectionId: string;
59681
- view: "automate" | "extract";
60873
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
60874
+ startDate?: string;
60875
+ /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
60876
+ endDate?: string;
59682
60877
  /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
59683
60878
  dateRange?: string;
59684
60879
  /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
@@ -59699,21 +60894,9 @@ export interface operations {
59699
60894
  "application/json": {
59700
60895
  data: {
59701
60896
  date: string;
59702
- total: number;
59703
- changes: {
59704
- completed?: {
59705
- [key: string]: number;
59706
- };
59707
- skipped?: {
59708
- [key: string]: number;
59709
- };
59710
- failed?: {
59711
- [key: string]: number;
59712
- };
59713
- queued?: {
59714
- [key: string]: number;
59715
- };
59716
- };
60897
+ grossGuestRevenue: number;
60898
+ pmRevenue: number;
60899
+ takeRate: number;
59717
60900
  }[];
59718
60901
  };
59719
60902
  };
@@ -59945,21 +61128,9 @@ export interface operations {
59945
61128
  };
59946
61129
  };
59947
61130
  };
59948
- getMetricTakeRate: {
61131
+ getPartner: {
59949
61132
  parameters: {
59950
- query?: {
59951
- interval?: "month" | "week" | "day" | "year";
59952
- /** @description Deprecated: use interval */
59953
- dimension?: "month" | "week" | "day" | "year";
59954
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
59955
- startDate?: string;
59956
- /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
59957
- endDate?: string;
59958
- /** @description Date range string. Accepted syntax: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`, or range `YYYY-MM-DD...YYYY-MM-DD` (legacy comma separator also accepted). Single values expand to the full year, month, or day. */
59959
- dateRange?: string;
59960
- /** @description Whether the end date in `dateRange` or `paidAtRange` is treated as inclusive (`true`) or exclusive (`false`). */
59961
- isDateRangeEndInclusive?: boolean;
59962
- };
61133
+ query?: never;
59963
61134
  header?: never;
59964
61135
  path?: never;
59965
61136
  cookie?: never;
@@ -59973,12 +61144,11 @@ export interface operations {
59973
61144
  };
59974
61145
  content: {
59975
61146
  "application/json": {
59976
- data: {
59977
- date: string;
59978
- grossGuestRevenue: number;
59979
- pmRevenue: number;
59980
- takeRate: number;
59981
- }[];
61147
+ /** Format: uuid */
61148
+ id: string;
61149
+ name: string;
61150
+ /** @constant */
61151
+ type: "partner";
59982
61152
  };
59983
61153
  };
59984
61154
  };
@@ -60132,8 +61302,58 @@ export interface operations {
60132
61302
  };
60133
61303
  };
60134
61304
  };
60135
- /** @description Unprocessable content */
60136
- 422: {
61305
+ /** @description Unprocessable content */
61306
+ 422: {
61307
+ headers: {
61308
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
61309
+ "Retry-After"?: number;
61310
+ [name: string]: unknown;
61311
+ };
61312
+ content: {
61313
+ "application/json": {
61314
+ code: string;
61315
+ message: string;
61316
+ links?: {
61317
+ docs: string;
61318
+ schema: string;
61319
+ };
61320
+ issues?: {
61321
+ message: string;
61322
+ path?: (string | number)[];
61323
+ schema?: string;
61324
+ }[];
61325
+ retryable?: boolean;
61326
+ context?: unknown;
61327
+ };
61328
+ };
61329
+ };
61330
+ /** @description Internal server error */
61331
+ 500: {
61332
+ headers: {
61333
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
61334
+ "Retry-After"?: number;
61335
+ [name: string]: unknown;
61336
+ };
61337
+ content: {
61338
+ "application/json": {
61339
+ code: string;
61340
+ message: string;
61341
+ links?: {
61342
+ docs: string;
61343
+ schema: string;
61344
+ };
61345
+ issues?: {
61346
+ message: string;
61347
+ path?: (string | number)[];
61348
+ schema?: string;
61349
+ }[];
61350
+ retryable?: boolean;
61351
+ context?: unknown;
61352
+ };
61353
+ };
61354
+ };
61355
+ /** @description Service unavailable */
61356
+ 503: {
60137
61357
  headers: {
60138
61358
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60139
61359
  "Retry-After"?: number;
@@ -60157,8 +61377,173 @@ export interface operations {
60157
61377
  };
60158
61378
  };
60159
61379
  };
60160
- /** @description Internal server error */
60161
- 500: {
61380
+ };
61381
+ };
61382
+ listPartnerAuditEvents: {
61383
+ parameters: {
61384
+ query?: {
61385
+ cursor?: string;
61386
+ limit?: number;
61387
+ order?: "asc" | "desc";
61388
+ /** @description Timestamp string with date, time, milliseconds, and timezone. */
61389
+ updatedFrom?: string;
61390
+ /** @description Timestamp string with date, time, milliseconds, and timezone. */
61391
+ updatedTo?: string;
61392
+ entityType?: "account" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "reservation" | "transaction";
61393
+ entityId?: string;
61394
+ actionId?: string;
61395
+ actionCode?: string;
61396
+ operation?: "create" | "update" | "delete" | "archive" | "restore" | "execute" | "recalculate";
61397
+ actorType?: "user" | "api_key" | "sync" | "automation" | "system";
61398
+ actorId?: string;
61399
+ accountingStatus?: string;
61400
+ accountId?: string;
61401
+ include?: "postingChanges";
61402
+ teamId?: string;
61403
+ };
61404
+ header?: {
61405
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
61406
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
61407
+ };
61408
+ path?: never;
61409
+ cookie?: never;
61410
+ };
61411
+ requestBody?: never;
61412
+ responses: {
61413
+ /** @description Successful response */
61414
+ 200: {
61415
+ headers: {
61416
+ [name: string]: unknown;
61417
+ };
61418
+ content: {
61419
+ "application/json": {
61420
+ data: {
61421
+ /** Format: uuid */
61422
+ id: string;
61423
+ revision: number;
61424
+ /** Format: uuid */
61425
+ actionId: string;
61426
+ team: {
61427
+ /** Format: uuid */
61428
+ id: string;
61429
+ uniqueRef: string | null;
61430
+ name: string;
61431
+ };
61432
+ /**
61433
+ * Format: date-time
61434
+ * @description Timestamp string with date, time, milliseconds, and timezone.
61435
+ * @example 2024-01-15T12:30:00.000+00:00
61436
+ */
61437
+ occurredAt: string;
61438
+ /**
61439
+ * Format: date-time
61440
+ * @description Timestamp string with date, time, milliseconds, and timezone.
61441
+ * @example 2024-01-15T12:30:00.000+00:00
61442
+ */
61443
+ updatedAt: string;
61444
+ actor: {
61445
+ /** @enum {string} */
61446
+ type: "user" | "api_key" | "sync" | "automation" | "system";
61447
+ id: string | null;
61448
+ name: string | null;
61449
+ email: string | null;
61450
+ label: string | null;
61451
+ };
61452
+ source: {
61453
+ /** @enum {string} */
61454
+ type: "portal" | "api" | "integration" | "sync" | "automation" | "system";
61455
+ requestId: string | null;
61456
+ };
61457
+ action: {
61458
+ code: string;
61459
+ summary: string;
61460
+ /** @enum {string} */
61461
+ operation: "create" | "update" | "delete" | "archive" | "restore" | "execute" | "recalculate";
61462
+ };
61463
+ rootEntity: {
61464
+ /** @enum {string} */
61465
+ type: "account" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "reservation" | "transaction";
61466
+ /** Format: uuid */
61467
+ id: string;
61468
+ uniqueRef: string | null;
61469
+ name: string | null;
61470
+ };
61471
+ entityChanges: {
61472
+ entity: {
61473
+ /** @enum {string} */
61474
+ type: "account" | "listing" | "listingOwnershipPeriod" | "ownerStatement" | "reservation" | "transaction" | "paymentLine";
61475
+ /** Format: uuid */
61476
+ id: string;
61477
+ uniqueRef: string | null;
61478
+ name: string | null;
61479
+ };
61480
+ /** @enum {string} */
61481
+ operation: "create" | "update" | "delete" | "archive" | "restore" | "execute" | "recalculate";
61482
+ changes: {
61483
+ path: string;
61484
+ before?: unknown;
61485
+ after?: unknown;
61486
+ }[];
61487
+ redactedFields: string[];
61488
+ }[];
61489
+ accountingImpact: {
61490
+ /** @enum {string} */
61491
+ status: "not_applicable" | "pending" | "unchanged" | "changed" | "blocked" | "failed" | "mixed";
61492
+ changedDimensions: ("account" | "amount" | "currency" | "posting_date" | "party" | "ledger" | "status" | "ownership_period" | "owner_statement")[];
61493
+ affected: {
61494
+ accounts: {
61495
+ /** Format: uuid */
61496
+ id: string;
61497
+ name: string;
61498
+ category: {
61499
+ /** Format: uuid */
61500
+ id: string;
61501
+ name: string;
61502
+ classification: string | null;
61503
+ };
61504
+ }[];
61505
+ periods: string[];
61506
+ ownershipPeriodIds: string[];
61507
+ ownerStatementIds: string[];
61508
+ };
61509
+ postingChanges?: {
61510
+ dimensions: {
61511
+ account: {
61512
+ /** Format: uuid */
61513
+ id: string;
61514
+ name: string;
61515
+ category: {
61516
+ /** Format: uuid */
61517
+ id: string;
61518
+ name: string;
61519
+ classification: string | null;
61520
+ };
61521
+ } | null;
61522
+ party: string | null;
61523
+ currency: string | null;
61524
+ postingDate: string | null;
61525
+ ledger: string | null;
61526
+ status: string | null;
61527
+ ownershipPeriodId: string | null;
61528
+ ownerStatementId: string | null;
61529
+ };
61530
+ centTotal: {
61531
+ before: number | null;
61532
+ after: number | null;
61533
+ };
61534
+ }[];
61535
+ };
61536
+ }[];
61537
+ page: {
61538
+ limit: number;
61539
+ hasMore: boolean;
61540
+ nextCursor: string | null;
61541
+ };
61542
+ };
61543
+ };
61544
+ };
61545
+ /** @description Bad request */
61546
+ 400: {
60162
61547
  headers: {
60163
61548
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60164
61549
  "Retry-After"?: number;
@@ -60182,8 +61567,8 @@ export interface operations {
60182
61567
  };
60183
61568
  };
60184
61569
  };
60185
- /** @description Service unavailable */
60186
- 503: {
61570
+ /** @description Unauthorized */
61571
+ 401: {
60187
61572
  headers: {
60188
61573
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60189
61574
  "Retry-After"?: number;
@@ -60207,34 +61592,8 @@ export interface operations {
60207
61592
  };
60208
61593
  };
60209
61594
  };
60210
- };
60211
- };
60212
- getPartner: {
60213
- parameters: {
60214
- query?: never;
60215
- header?: never;
60216
- path?: never;
60217
- cookie?: never;
60218
- };
60219
- requestBody?: never;
60220
- responses: {
60221
- /** @description Successful response */
60222
- 200: {
60223
- headers: {
60224
- [name: string]: unknown;
60225
- };
60226
- content: {
60227
- "application/json": {
60228
- /** Format: uuid */
60229
- id: string;
60230
- name: string;
60231
- /** @constant */
60232
- type: "partner";
60233
- };
60234
- };
60235
- };
60236
- /** @description Bad request */
60237
- 400: {
61595
+ /** @description Forbidden */
61596
+ 403: {
60238
61597
  headers: {
60239
61598
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60240
61599
  "Retry-After"?: number;
@@ -60258,8 +61617,8 @@ export interface operations {
60258
61617
  };
60259
61618
  };
60260
61619
  };
60261
- /** @description Unauthorized */
60262
- 401: {
61620
+ /** @description Not found */
61621
+ 404: {
60263
61622
  headers: {
60264
61623
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60265
61624
  "Retry-After"?: number;
@@ -60283,8 +61642,8 @@ export interface operations {
60283
61642
  };
60284
61643
  };
60285
61644
  };
60286
- /** @description Forbidden */
60287
- 403: {
61645
+ /** @description Conflict */
61646
+ 409: {
60288
61647
  headers: {
60289
61648
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60290
61649
  "Retry-After"?: number;
@@ -60308,8 +61667,8 @@ export interface operations {
60308
61667
  };
60309
61668
  };
60310
61669
  };
60311
- /** @description Not found */
60312
- 404: {
61670
+ /** @description Audit cursor expired */
61671
+ 410: {
60313
61672
  headers: {
60314
61673
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60315
61674
  "Retry-After"?: number;
@@ -60333,8 +61692,8 @@ export interface operations {
60333
61692
  };
60334
61693
  };
60335
61694
  };
60336
- /** @description Conflict */
60337
- 409: {
61695
+ /** @description Misdirected regional request */
61696
+ 421: {
60338
61697
  headers: {
60339
61698
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60340
61699
  "Retry-After"?: number;
@@ -60358,8 +61717,8 @@ export interface operations {
60358
61717
  };
60359
61718
  };
60360
61719
  };
60361
- /** @description Gone */
60362
- 410: {
61720
+ /** @description Unprocessable content */
61721
+ 422: {
60363
61722
  headers: {
60364
61723
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60365
61724
  "Retry-After"?: number;
@@ -60383,8 +61742,8 @@ export interface operations {
60383
61742
  };
60384
61743
  };
60385
61744
  };
60386
- /** @description Unprocessable content */
60387
- 422: {
61745
+ /** @description Rate limited */
61746
+ 429: {
60388
61747
  headers: {
60389
61748
  /** @description Seconds to wait when retryable=true and the server supplies a delay. */
60390
61749
  "Retry-After"?: number;
@@ -85905,6 +87264,11 @@ export interface operations {
85905
87264
  severity: "error";
85906
87265
  context: {
85907
87266
  lineIds: string[];
87267
+ lines: {
87268
+ amount: number;
87269
+ lineId: string;
87270
+ name: string;
87271
+ }[];
85908
87272
  };
85909
87273
  message: string;
85910
87274
  } | {
@@ -85914,6 +87278,8 @@ export interface operations {
85914
87278
  severity: "error";
85915
87279
  context: {
85916
87280
  difference: number;
87281
+ journalEntryTotal: number;
87282
+ unbalancedTransactionDateCount: number;
85917
87283
  };
85918
87284
  message: string;
85919
87285
  } | {
@@ -85970,7 +87336,9 @@ export interface operations {
85970
87336
  /** @constant */
85971
87337
  severity: "warning";
85972
87338
  context: {
87339
+ activeFinancialTotal: number;
85973
87340
  difference: number;
87341
+ guestTotal: number;
85974
87342
  };
85975
87343
  message: string;
85976
87344
  } | {
@@ -86426,6 +87794,11 @@ export interface operations {
86426
87794
  severity: "error";
86427
87795
  context: {
86428
87796
  lineIds: string[];
87797
+ lines: {
87798
+ amount: number;
87799
+ lineId: string;
87800
+ name: string;
87801
+ }[];
86429
87802
  };
86430
87803
  message: string;
86431
87804
  } | {
@@ -86435,6 +87808,8 @@ export interface operations {
86435
87808
  severity: "error";
86436
87809
  context: {
86437
87810
  difference: number;
87811
+ journalEntryTotal: number;
87812
+ unbalancedTransactionDateCount: number;
86438
87813
  };
86439
87814
  message: string;
86440
87815
  } | {
@@ -86491,7 +87866,9 @@ export interface operations {
86491
87866
  /** @constant */
86492
87867
  severity: "warning";
86493
87868
  context: {
87869
+ activeFinancialTotal: number;
86494
87870
  difference: number;
87871
+ guestTotal: number;
86495
87872
  };
86496
87873
  message: string;
86497
87874
  } | {
@@ -89073,6 +90450,11 @@ export interface operations {
89073
90450
  severity: "error";
89074
90451
  context: {
89075
90452
  lineIds: string[];
90453
+ lines: {
90454
+ amount: number;
90455
+ lineId: string;
90456
+ name: string;
90457
+ }[];
89076
90458
  };
89077
90459
  message: string;
89078
90460
  } | {
@@ -89082,6 +90464,8 @@ export interface operations {
89082
90464
  severity: "error";
89083
90465
  context: {
89084
90466
  difference: number;
90467
+ journalEntryTotal: number;
90468
+ unbalancedTransactionDateCount: number;
89085
90469
  };
89086
90470
  message: string;
89087
90471
  } | {
@@ -89138,7 +90522,9 @@ export interface operations {
89138
90522
  /** @constant */
89139
90523
  severity: "warning";
89140
90524
  context: {
90525
+ activeFinancialTotal: number;
89141
90526
  difference: number;
90527
+ guestTotal: number;
89142
90528
  };
89143
90529
  message: string;
89144
90530
  } | {
@@ -89845,6 +91231,11 @@ export interface operations {
89845
91231
  severity: "error";
89846
91232
  context: {
89847
91233
  lineIds: string[];
91234
+ lines: {
91235
+ amount: number;
91236
+ lineId: string;
91237
+ name: string;
91238
+ }[];
89848
91239
  };
89849
91240
  message: string;
89850
91241
  } | {
@@ -89854,6 +91245,8 @@ export interface operations {
89854
91245
  severity: "error";
89855
91246
  context: {
89856
91247
  difference: number;
91248
+ journalEntryTotal: number;
91249
+ unbalancedTransactionDateCount: number;
89857
91250
  };
89858
91251
  message: string;
89859
91252
  } | {
@@ -89910,7 +91303,9 @@ export interface operations {
89910
91303
  /** @constant */
89911
91304
  severity: "warning";
89912
91305
  context: {
91306
+ activeFinancialTotal: number;
89913
91307
  difference: number;
91308
+ guestTotal: number;
89914
91309
  };
89915
91310
  message: string;
89916
91311
  } | {
@@ -91031,6 +92426,11 @@ export interface operations {
91031
92426
  severity: "error";
91032
92427
  context: {
91033
92428
  lineIds: string[];
92429
+ lines: {
92430
+ amount: number;
92431
+ lineId: string;
92432
+ name: string;
92433
+ }[];
91034
92434
  };
91035
92435
  message: string;
91036
92436
  } | {
@@ -91040,6 +92440,8 @@ export interface operations {
91040
92440
  severity: "error";
91041
92441
  context: {
91042
92442
  difference: number;
92443
+ journalEntryTotal: number;
92444
+ unbalancedTransactionDateCount: number;
91043
92445
  };
91044
92446
  message: string;
91045
92447
  } | {
@@ -91096,7 +92498,9 @@ export interface operations {
91096
92498
  /** @constant */
91097
92499
  severity: "warning";
91098
92500
  context: {
92501
+ activeFinancialTotal: number;
91099
92502
  difference: number;
92503
+ guestTotal: number;
91100
92504
  };
91101
92505
  message: string;
91102
92506
  } | {
@@ -91695,6 +93099,11 @@ export interface operations {
91695
93099
  severity: "error";
91696
93100
  context: {
91697
93101
  lineIds: string[];
93102
+ lines: {
93103
+ amount: number;
93104
+ lineId: string;
93105
+ name: string;
93106
+ }[];
91698
93107
  };
91699
93108
  message: string;
91700
93109
  } | {
@@ -91704,6 +93113,8 @@ export interface operations {
91704
93113
  severity: "error";
91705
93114
  context: {
91706
93115
  difference: number;
93116
+ journalEntryTotal: number;
93117
+ unbalancedTransactionDateCount: number;
91707
93118
  };
91708
93119
  message: string;
91709
93120
  } | {
@@ -91760,7 +93171,9 @@ export interface operations {
91760
93171
  /** @constant */
91761
93172
  severity: "warning";
91762
93173
  context: {
93174
+ activeFinancialTotal: number;
91763
93175
  difference: number;
93176
+ guestTotal: number;
91764
93177
  };
91765
93178
  message: string;
91766
93179
  } | {
@@ -92341,6 +93754,11 @@ export interface operations {
92341
93754
  severity: "error";
92342
93755
  context: {
92343
93756
  lineIds: string[];
93757
+ lines: {
93758
+ amount: number;
93759
+ lineId: string;
93760
+ name: string;
93761
+ }[];
92344
93762
  };
92345
93763
  message: string;
92346
93764
  } | {
@@ -92350,6 +93768,8 @@ export interface operations {
92350
93768
  severity: "error";
92351
93769
  context: {
92352
93770
  difference: number;
93771
+ journalEntryTotal: number;
93772
+ unbalancedTransactionDateCount: number;
92353
93773
  };
92354
93774
  message: string;
92355
93775
  } | {
@@ -92406,7 +93826,9 @@ export interface operations {
92406
93826
  /** @constant */
92407
93827
  severity: "warning";
92408
93828
  context: {
93829
+ activeFinancialTotal: number;
92409
93830
  difference: number;
93831
+ guestTotal: number;
92410
93832
  };
92411
93833
  message: string;
92412
93834
  } | {
@@ -93336,7 +94758,9 @@ export interface operations {
93336
94758
  code: "unpaidReservations";
93337
94759
  /** @constant */
93338
94760
  severity: "warning";
93339
- context: Record<string, never>;
94761
+ context: {
94762
+ affected: number;
94763
+ };
93340
94764
  message: string;
93341
94765
  } | {
93342
94766
  /** @constant */
@@ -94030,7 +95454,9 @@ export interface operations {
94030
95454
  code: "unpaidReservations";
94031
95455
  /** @constant */
94032
95456
  severity: "warning";
94033
- context: Record<string, never>;
95457
+ context: {
95458
+ affected: number;
95459
+ };
94034
95460
  message: string;
94035
95461
  } | {
94036
95462
  /** @constant */
@@ -94391,7 +95817,9 @@ export interface operations {
94391
95817
  code: "unpaidReservation";
94392
95818
  /** @constant */
94393
95819
  severity: "warning";
94394
- context: Record<string, never>;
95820
+ context: {
95821
+ paidStatus: string;
95822
+ };
94395
95823
  message: string;
94396
95824
  })[];
94397
95825
  descriptionEdit?: {
@@ -94656,7 +96084,9 @@ export interface operations {
94656
96084
  code: "unpaidReservation";
94657
96085
  /** @constant */
94658
96086
  severity: "warning";
94659
- context: Record<string, never>;
96087
+ context: {
96088
+ paidStatus: string;
96089
+ };
94660
96090
  message: string;
94661
96091
  })[];
94662
96092
  descriptionEdit?: {
@@ -94926,7 +96356,9 @@ export interface operations {
94926
96356
  code: "unpaidReservation";
94927
96357
  /** @constant */
94928
96358
  severity: "warning";
94929
- context: Record<string, never>;
96359
+ context: {
96360
+ paidStatus: string;
96361
+ };
94930
96362
  message: string;
94931
96363
  })[];
94932
96364
  descriptionEdit?: {
@@ -95545,7 +96977,9 @@ export interface operations {
95545
96977
  code: "unpaidReservations";
95546
96978
  /** @constant */
95547
96979
  severity: "warning";
95548
- context: Record<string, never>;
96980
+ context: {
96981
+ affected: number;
96982
+ };
95549
96983
  message: string;
95550
96984
  } | {
95551
96985
  /** @constant */
@@ -95935,7 +97369,9 @@ export interface operations {
95935
97369
  code: "unpaidReservation";
95936
97370
  /** @constant */
95937
97371
  severity: "warning";
95938
- context: Record<string, never>;
97372
+ context: {
97373
+ paidStatus: string;
97374
+ };
95939
97375
  message: string;
95940
97376
  })[];
95941
97377
  descriptionEdit?: {
@@ -96200,7 +97636,9 @@ export interface operations {
96200
97636
  code: "unpaidReservation";
96201
97637
  /** @constant */
96202
97638
  severity: "warning";
96203
- context: Record<string, never>;
97639
+ context: {
97640
+ paidStatus: string;
97641
+ };
96204
97642
  message: string;
96205
97643
  })[];
96206
97644
  descriptionEdit?: {
@@ -96470,7 +97908,9 @@ export interface operations {
96470
97908
  code: "unpaidReservation";
96471
97909
  /** @constant */
96472
97910
  severity: "warning";
96473
- context: Record<string, never>;
97911
+ context: {
97912
+ paidStatus: string;
97913
+ };
96474
97914
  message: string;
96475
97915
  })[];
96476
97916
  descriptionEdit?: {
@@ -102802,7 +104242,9 @@ export interface operations {
102802
104242
  code: "unpaidReservations";
102803
104243
  /** @constant */
102804
104244
  severity: "warning";
102805
- context: Record<string, never>;
104245
+ context: {
104246
+ affected: number;
104247
+ };
102806
104248
  message: string;
102807
104249
  } | {
102808
104250
  /** @constant */
@@ -103192,7 +104634,9 @@ export interface operations {
103192
104634
  code: "unpaidReservation";
103193
104635
  /** @constant */
103194
104636
  severity: "warning";
103195
- context: Record<string, never>;
104637
+ context: {
104638
+ paidStatus: string;
104639
+ };
103196
104640
  message: string;
103197
104641
  })[];
103198
104642
  descriptionEdit?: {
@@ -103457,7 +104901,9 @@ export interface operations {
103457
104901
  code: "unpaidReservation";
103458
104902
  /** @constant */
103459
104903
  severity: "warning";
103460
- context: Record<string, never>;
104904
+ context: {
104905
+ paidStatus: string;
104906
+ };
103461
104907
  message: string;
103462
104908
  })[];
103463
104909
  descriptionEdit?: {
@@ -103727,7 +105173,9 @@ export interface operations {
103727
105173
  code: "unpaidReservation";
103728
105174
  /** @constant */
103729
105175
  severity: "warning";
103730
- context: Record<string, never>;
105176
+ context: {
105177
+ paidStatus: string;
105178
+ };
103731
105179
  message: string;
103732
105180
  })[];
103733
105181
  descriptionEdit?: {
@@ -104354,7 +105802,9 @@ export interface operations {
104354
105802
  code: "unpaidReservations";
104355
105803
  /** @constant */
104356
105804
  severity: "warning";
104357
- context: Record<string, never>;
105805
+ context: {
105806
+ affected: number;
105807
+ };
104358
105808
  message: string;
104359
105809
  } | {
104360
105810
  /** @constant */
@@ -104715,7 +106165,9 @@ export interface operations {
104715
106165
  code: "unpaidReservation";
104716
106166
  /** @constant */
104717
106167
  severity: "warning";
104718
- context: Record<string, never>;
106168
+ context: {
106169
+ paidStatus: string;
106170
+ };
104719
106171
  message: string;
104720
106172
  })[];
104721
106173
  descriptionEdit?: {
@@ -104980,7 +106432,9 @@ export interface operations {
104980
106432
  code: "unpaidReservation";
104981
106433
  /** @constant */
104982
106434
  severity: "warning";
104983
- context: Record<string, never>;
106435
+ context: {
106436
+ paidStatus: string;
106437
+ };
104984
106438
  message: string;
104985
106439
  })[];
104986
106440
  descriptionEdit?: {
@@ -105250,7 +106704,9 @@ export interface operations {
105250
106704
  code: "unpaidReservation";
105251
106705
  /** @constant */
105252
106706
  severity: "warning";
105253
- context: Record<string, never>;
106707
+ context: {
106708
+ paidStatus: string;
106709
+ };
105254
106710
  message: string;
105255
106711
  })[];
105256
106712
  descriptionEdit?: {