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