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