@vrplatform/api 1.3.1-stage.6125 → 1.3.1-stage.6149

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.
@@ -3132,6 +3132,27 @@ export interface paths {
3132
3132
  patch?: never;
3133
3133
  trace?: never;
3134
3134
  };
3135
+ "/operations/{id}": {
3136
+ parameters: {
3137
+ query?: never;
3138
+ header?: never;
3139
+ path?: never;
3140
+ cookie?: never;
3141
+ };
3142
+ /**
3143
+ * @description Get the normalized lifecycle status of one asynchronous operation owned by the requesting tenant. Payloads, errors, effect details, and runtime identifiers remain private. See https://docs.vrplatform.app/guides/integrate/batch-imports#asynchronous-operations.
3144
+ *
3145
+ * Required scope: operations:read
3146
+ */
3147
+ get: operations["getOperation"];
3148
+ put?: never;
3149
+ post?: never;
3150
+ delete?: never;
3151
+ options?: never;
3152
+ head?: never;
3153
+ patch?: never;
3154
+ trace?: never;
3155
+ };
3135
3156
  "/partner": {
3136
3157
  parameters: {
3137
3158
  query?: never;
@@ -3363,27 +3384,6 @@ export interface paths {
3363
3384
  patch?: never;
3364
3385
  trace?: never;
3365
3386
  };
3366
- "/partner/operations/{id}": {
3367
- parameters: {
3368
- query?: never;
3369
- header?: never;
3370
- path?: never;
3371
- cookie?: never;
3372
- };
3373
- /**
3374
- * @description Get the normalized lifecycle status of one asynchronous operation owned by the authenticated partner. Payloads, errors, effect details, and runtime identifiers remain private. See https://docs.vrplatform.app/guides/integrate/batch-imports#asynchronous-operations.
3375
- *
3376
- * Required scope: operations:read
3377
- */
3378
- get: operations["getPartnerOperation"];
3379
- put?: never;
3380
- post?: never;
3381
- delete?: never;
3382
- options?: never;
3383
- head?: never;
3384
- patch?: never;
3385
- trace?: never;
3386
- };
3387
3387
  "/partner/owner-statements": {
3388
3388
  parameters: {
3389
3389
  query?: never;
@@ -3525,7 +3525,7 @@ export interface paths {
3525
3525
  get?: never;
3526
3526
  put?: never;
3527
3527
  /**
3528
- * @description Queue a tracked asynchronous operation that imports historical VRI statements into an existing migrated GL-enabled team after resolving account paths and validating statement and reservation listing targets. Poll the returned operationId through the Partner operation status endpoint. See https://docs.vrplatform.app/guides/integrate/vri-migration.
3528
+ * @description Queue a tracked asynchronous operation that imports historical VRI statements into an existing migrated GL-enabled team after resolving account paths, exact listing suggestions, and explicit mappings for every remaining listing. Poll the returned operationId through GET /operations/{id}. See https://docs.vrplatform.app/guides/integrate/vri-migration.
3529
3529
  *
3530
3530
  * Required scope: general-ledger:import
3531
3531
  */
@@ -64417,6 +64417,271 @@ export interface operations {
64417
64417
  };
64418
64418
  };
64419
64419
  };
64420
+ getOperation: {
64421
+ parameters: {
64422
+ query?: never;
64423
+ header?: {
64424
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
64425
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
64426
+ };
64427
+ path: {
64428
+ id: string;
64429
+ };
64430
+ cookie?: never;
64431
+ };
64432
+ requestBody?: never;
64433
+ responses: {
64434
+ /** @description Successful response */
64435
+ 200: {
64436
+ headers: {
64437
+ [name: string]: unknown;
64438
+ };
64439
+ content: {
64440
+ "application/json": {
64441
+ /** Format: uuid */
64442
+ id: string;
64443
+ /** @enum {string} */
64444
+ type: "vri-statement-import";
64445
+ /** @enum {string} */
64446
+ status: "queued" | "running" | "completed" | "failed";
64447
+ /**
64448
+ * Format: date-time
64449
+ * @description Timestamp string with date, time, milliseconds, and timezone.
64450
+ * @example 2024-01-15T12:30:00.000+00:00
64451
+ */
64452
+ createdAt: string;
64453
+ startedAt: string | null;
64454
+ finishedAt: string | null;
64455
+ };
64456
+ };
64457
+ };
64458
+ /** @description Bad request */
64459
+ 400: {
64460
+ headers: {
64461
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
64462
+ "Retry-After"?: number;
64463
+ [name: string]: unknown;
64464
+ };
64465
+ content: {
64466
+ "application/json": {
64467
+ code: string;
64468
+ message: string;
64469
+ links?: {
64470
+ docs: string;
64471
+ schema: string;
64472
+ };
64473
+ issues?: {
64474
+ message: string;
64475
+ path?: (string | number)[];
64476
+ schema?: string;
64477
+ }[];
64478
+ retryable?: boolean;
64479
+ context?: unknown;
64480
+ };
64481
+ };
64482
+ };
64483
+ /** @description Unauthorized */
64484
+ 401: {
64485
+ headers: {
64486
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
64487
+ "Retry-After"?: number;
64488
+ [name: string]: unknown;
64489
+ };
64490
+ content: {
64491
+ "application/json": {
64492
+ code: string;
64493
+ message: string;
64494
+ links?: {
64495
+ docs: string;
64496
+ schema: string;
64497
+ };
64498
+ issues?: {
64499
+ message: string;
64500
+ path?: (string | number)[];
64501
+ schema?: string;
64502
+ }[];
64503
+ retryable?: boolean;
64504
+ context?: unknown;
64505
+ };
64506
+ };
64507
+ };
64508
+ /** @description Forbidden */
64509
+ 403: {
64510
+ headers: {
64511
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
64512
+ "Retry-After"?: number;
64513
+ [name: string]: unknown;
64514
+ };
64515
+ content: {
64516
+ "application/json": {
64517
+ code: string;
64518
+ message: string;
64519
+ links?: {
64520
+ docs: string;
64521
+ schema: string;
64522
+ };
64523
+ issues?: {
64524
+ message: string;
64525
+ path?: (string | number)[];
64526
+ schema?: string;
64527
+ }[];
64528
+ retryable?: boolean;
64529
+ context?: unknown;
64530
+ };
64531
+ };
64532
+ };
64533
+ /** @description Not found */
64534
+ 404: {
64535
+ headers: {
64536
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
64537
+ "Retry-After"?: number;
64538
+ [name: string]: unknown;
64539
+ };
64540
+ content: {
64541
+ "application/json": {
64542
+ code: string;
64543
+ message: string;
64544
+ links?: {
64545
+ docs: string;
64546
+ schema: string;
64547
+ };
64548
+ issues?: {
64549
+ message: string;
64550
+ path?: (string | number)[];
64551
+ schema?: string;
64552
+ }[];
64553
+ retryable?: boolean;
64554
+ context?: unknown;
64555
+ };
64556
+ };
64557
+ };
64558
+ /** @description Conflict */
64559
+ 409: {
64560
+ headers: {
64561
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
64562
+ "Retry-After"?: number;
64563
+ [name: string]: unknown;
64564
+ };
64565
+ content: {
64566
+ "application/json": {
64567
+ code: string;
64568
+ message: string;
64569
+ links?: {
64570
+ docs: string;
64571
+ schema: string;
64572
+ };
64573
+ issues?: {
64574
+ message: string;
64575
+ path?: (string | number)[];
64576
+ schema?: string;
64577
+ }[];
64578
+ retryable?: boolean;
64579
+ context?: unknown;
64580
+ };
64581
+ };
64582
+ };
64583
+ /** @description Gone */
64584
+ 410: {
64585
+ headers: {
64586
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
64587
+ "Retry-After"?: number;
64588
+ [name: string]: unknown;
64589
+ };
64590
+ content: {
64591
+ "application/json": {
64592
+ code: string;
64593
+ message: string;
64594
+ links?: {
64595
+ docs: string;
64596
+ schema: string;
64597
+ };
64598
+ issues?: {
64599
+ message: string;
64600
+ path?: (string | number)[];
64601
+ schema?: string;
64602
+ }[];
64603
+ retryable?: boolean;
64604
+ context?: unknown;
64605
+ };
64606
+ };
64607
+ };
64608
+ /** @description Unprocessable content */
64609
+ 422: {
64610
+ headers: {
64611
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
64612
+ "Retry-After"?: number;
64613
+ [name: string]: unknown;
64614
+ };
64615
+ content: {
64616
+ "application/json": {
64617
+ code: string;
64618
+ message: string;
64619
+ links?: {
64620
+ docs: string;
64621
+ schema: string;
64622
+ };
64623
+ issues?: {
64624
+ message: string;
64625
+ path?: (string | number)[];
64626
+ schema?: string;
64627
+ }[];
64628
+ retryable?: boolean;
64629
+ context?: unknown;
64630
+ };
64631
+ };
64632
+ };
64633
+ /** @description Internal server error */
64634
+ 500: {
64635
+ headers: {
64636
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
64637
+ "Retry-After"?: number;
64638
+ [name: string]: unknown;
64639
+ };
64640
+ content: {
64641
+ "application/json": {
64642
+ code: string;
64643
+ message: string;
64644
+ links?: {
64645
+ docs: string;
64646
+ schema: string;
64647
+ };
64648
+ issues?: {
64649
+ message: string;
64650
+ path?: (string | number)[];
64651
+ schema?: string;
64652
+ }[];
64653
+ retryable?: boolean;
64654
+ context?: unknown;
64655
+ };
64656
+ };
64657
+ };
64658
+ /** @description Service unavailable */
64659
+ 503: {
64660
+ headers: {
64661
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
64662
+ "Retry-After"?: number;
64663
+ [name: string]: unknown;
64664
+ };
64665
+ content: {
64666
+ "application/json": {
64667
+ code: string;
64668
+ message: string;
64669
+ links?: {
64670
+ docs: string;
64671
+ schema: string;
64672
+ };
64673
+ issues?: {
64674
+ message: string;
64675
+ path?: (string | number)[];
64676
+ schema?: string;
64677
+ }[];
64678
+ retryable?: boolean;
64679
+ context?: unknown;
64680
+ };
64681
+ };
64682
+ };
64683
+ };
64684
+ };
64420
64685
  getPartner: {
64421
64686
  parameters: {
64422
64687
  query?: never;
@@ -67762,269 +68027,6 @@ export interface operations {
67762
68027
  };
67763
68028
  };
67764
68029
  };
67765
- getPartnerOperation: {
67766
- parameters: {
67767
- query?: never;
67768
- header?: {
67769
- /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
67770
- "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
67771
- };
67772
- path: {
67773
- id: string;
67774
- };
67775
- cookie?: never;
67776
- };
67777
- requestBody?: never;
67778
- responses: {
67779
- /** @description Successful response */
67780
- 200: {
67781
- headers: {
67782
- [name: string]: unknown;
67783
- };
67784
- content: {
67785
- "application/json": {
67786
- /** Format: uuid */
67787
- id: string;
67788
- /** @enum {string} */
67789
- status: "queued" | "running" | "completed" | "failed";
67790
- /**
67791
- * Format: date-time
67792
- * @description Timestamp string with date, time, milliseconds, and timezone.
67793
- * @example 2024-01-15T12:30:00.000+00:00
67794
- */
67795
- createdAt: string;
67796
- startedAt: string | null;
67797
- finishedAt: string | null;
67798
- };
67799
- };
67800
- };
67801
- /** @description Bad request */
67802
- 400: {
67803
- headers: {
67804
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
67805
- "Retry-After"?: number;
67806
- [name: string]: unknown;
67807
- };
67808
- content: {
67809
- "application/json": {
67810
- code: string;
67811
- message: string;
67812
- links?: {
67813
- docs: string;
67814
- schema: string;
67815
- };
67816
- issues?: {
67817
- message: string;
67818
- path?: (string | number)[];
67819
- schema?: string;
67820
- }[];
67821
- retryable?: boolean;
67822
- context?: unknown;
67823
- };
67824
- };
67825
- };
67826
- /** @description Unauthorized */
67827
- 401: {
67828
- headers: {
67829
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
67830
- "Retry-After"?: number;
67831
- [name: string]: unknown;
67832
- };
67833
- content: {
67834
- "application/json": {
67835
- code: string;
67836
- message: string;
67837
- links?: {
67838
- docs: string;
67839
- schema: string;
67840
- };
67841
- issues?: {
67842
- message: string;
67843
- path?: (string | number)[];
67844
- schema?: string;
67845
- }[];
67846
- retryable?: boolean;
67847
- context?: unknown;
67848
- };
67849
- };
67850
- };
67851
- /** @description Forbidden */
67852
- 403: {
67853
- headers: {
67854
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
67855
- "Retry-After"?: number;
67856
- [name: string]: unknown;
67857
- };
67858
- content: {
67859
- "application/json": {
67860
- code: string;
67861
- message: string;
67862
- links?: {
67863
- docs: string;
67864
- schema: string;
67865
- };
67866
- issues?: {
67867
- message: string;
67868
- path?: (string | number)[];
67869
- schema?: string;
67870
- }[];
67871
- retryable?: boolean;
67872
- context?: unknown;
67873
- };
67874
- };
67875
- };
67876
- /** @description Not found */
67877
- 404: {
67878
- headers: {
67879
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
67880
- "Retry-After"?: number;
67881
- [name: string]: unknown;
67882
- };
67883
- content: {
67884
- "application/json": {
67885
- code: string;
67886
- message: string;
67887
- links?: {
67888
- docs: string;
67889
- schema: string;
67890
- };
67891
- issues?: {
67892
- message: string;
67893
- path?: (string | number)[];
67894
- schema?: string;
67895
- }[];
67896
- retryable?: boolean;
67897
- context?: unknown;
67898
- };
67899
- };
67900
- };
67901
- /** @description Conflict */
67902
- 409: {
67903
- headers: {
67904
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
67905
- "Retry-After"?: number;
67906
- [name: string]: unknown;
67907
- };
67908
- content: {
67909
- "application/json": {
67910
- code: string;
67911
- message: string;
67912
- links?: {
67913
- docs: string;
67914
- schema: string;
67915
- };
67916
- issues?: {
67917
- message: string;
67918
- path?: (string | number)[];
67919
- schema?: string;
67920
- }[];
67921
- retryable?: boolean;
67922
- context?: unknown;
67923
- };
67924
- };
67925
- };
67926
- /** @description Gone */
67927
- 410: {
67928
- headers: {
67929
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
67930
- "Retry-After"?: number;
67931
- [name: string]: unknown;
67932
- };
67933
- content: {
67934
- "application/json": {
67935
- code: string;
67936
- message: string;
67937
- links?: {
67938
- docs: string;
67939
- schema: string;
67940
- };
67941
- issues?: {
67942
- message: string;
67943
- path?: (string | number)[];
67944
- schema?: string;
67945
- }[];
67946
- retryable?: boolean;
67947
- context?: unknown;
67948
- };
67949
- };
67950
- };
67951
- /** @description Unprocessable content */
67952
- 422: {
67953
- headers: {
67954
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
67955
- "Retry-After"?: number;
67956
- [name: string]: unknown;
67957
- };
67958
- content: {
67959
- "application/json": {
67960
- code: string;
67961
- message: string;
67962
- links?: {
67963
- docs: string;
67964
- schema: string;
67965
- };
67966
- issues?: {
67967
- message: string;
67968
- path?: (string | number)[];
67969
- schema?: string;
67970
- }[];
67971
- retryable?: boolean;
67972
- context?: unknown;
67973
- };
67974
- };
67975
- };
67976
- /** @description Internal server error */
67977
- 500: {
67978
- headers: {
67979
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
67980
- "Retry-After"?: number;
67981
- [name: string]: unknown;
67982
- };
67983
- content: {
67984
- "application/json": {
67985
- code: string;
67986
- message: string;
67987
- links?: {
67988
- docs: string;
67989
- schema: string;
67990
- };
67991
- issues?: {
67992
- message: string;
67993
- path?: (string | number)[];
67994
- schema?: string;
67995
- }[];
67996
- retryable?: boolean;
67997
- context?: unknown;
67998
- };
67999
- };
68000
- };
68001
- /** @description Service unavailable */
68002
- 503: {
68003
- headers: {
68004
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
68005
- "Retry-After"?: number;
68006
- [name: string]: unknown;
68007
- };
68008
- content: {
68009
- "application/json": {
68010
- code: string;
68011
- message: string;
68012
- links?: {
68013
- docs: string;
68014
- schema: string;
68015
- };
68016
- issues?: {
68017
- message: string;
68018
- path?: (string | number)[];
68019
- schema?: string;
68020
- }[];
68021
- retryable?: boolean;
68022
- context?: unknown;
68023
- };
68024
- };
68025
- };
68026
- };
68027
- };
68028
68030
  getPartnerOwnerStatements: {
68029
68031
  parameters: {
68030
68032
  query?: {