@vrplatform/api 1.3.1-stage.4191 → 1.3.1-stage.4192

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.
@@ -920,6 +920,59 @@ export interface paths {
920
920
  patch?: never;
921
921
  trace?: never;
922
922
  };
923
+ "/files": {
924
+ parameters: {
925
+ query?: never;
926
+ header?: never;
927
+ path?: never;
928
+ cookie?: never;
929
+ };
930
+ /** @description List GL user-uploaded files for the current team. */
931
+ get: operations["getFiles"];
932
+ put?: never;
933
+ /** @description Upload a GL user file as multipart/form-data. Fields: file, optional filename, optional startDate, optional endDate, and optional contactId. The API derives team and user context from auth. */
934
+ post: operations["postFiles"];
935
+ delete?: never;
936
+ options?: never;
937
+ head?: never;
938
+ patch?: never;
939
+ trace?: never;
940
+ };
941
+ "/files/{id}": {
942
+ parameters: {
943
+ query?: never;
944
+ header?: never;
945
+ path?: never;
946
+ cookie?: never;
947
+ };
948
+ get?: never;
949
+ put?: never;
950
+ post?: never;
951
+ /** @description Delete GL file metadata and its TEAM_STORAGE object. */
952
+ delete: operations["deleteFilesById"];
953
+ options?: never;
954
+ head?: never;
955
+ /** @description Update GL file metadata: filename, date range, and contact. */
956
+ patch: operations["patchFilesById"];
957
+ trace?: never;
958
+ };
959
+ "/files/{id}/download": {
960
+ parameters: {
961
+ query?: never;
962
+ header?: never;
963
+ path?: never;
964
+ cookie?: never;
965
+ };
966
+ /** @description Download a GL user-uploaded file. */
967
+ get: operations["getFilesByIdDownload"];
968
+ put?: never;
969
+ post?: never;
970
+ delete?: never;
971
+ options?: never;
972
+ head?: never;
973
+ patch?: never;
974
+ trace?: never;
975
+ };
923
976
  "/flows": {
924
977
  parameters: {
925
978
  query?: never;
@@ -17399,6 +17452,774 @@ export interface operations {
17399
17452
  };
17400
17453
  };
17401
17454
  };
17455
+ getFiles: {
17456
+ parameters: {
17457
+ query?: {
17458
+ search?: string;
17459
+ sortBy?: "filename" | "startDate" | "endDate" | "createdAt" | "contactName";
17460
+ sortDirection?: "asc" | "desc";
17461
+ limit?: number;
17462
+ page?: number;
17463
+ offset?: number;
17464
+ };
17465
+ header?: never;
17466
+ path?: never;
17467
+ cookie?: never;
17468
+ };
17469
+ requestBody?: never;
17470
+ responses: {
17471
+ /** @description Successful response */
17472
+ 200: {
17473
+ headers: {
17474
+ [name: string]: unknown;
17475
+ };
17476
+ content: {
17477
+ "application/json": {
17478
+ data: {
17479
+ /** Format: uuid */
17480
+ id: string;
17481
+ filename: string;
17482
+ /** @constant */
17483
+ type: "userUpload";
17484
+ startDate: string | null;
17485
+ endDate: string | null;
17486
+ /**
17487
+ * Format: date-time
17488
+ * @description Timestamp string with date, time, milliseconds, and timezone.
17489
+ * @example 2024-01-15T12:30:00.000+00:00
17490
+ */
17491
+ createdAt: string;
17492
+ contact: {
17493
+ /** Format: uuid */
17494
+ id: string;
17495
+ name?: string | null;
17496
+ firstName?: string | null;
17497
+ uniqueRef?: string | null;
17498
+ shortRef?: string | null;
17499
+ email?: string | null;
17500
+ /** @enum {string} */
17501
+ type: "owner" | "vendor";
17502
+ } | null;
17503
+ }[];
17504
+ pagination: {
17505
+ /** @default 100 */
17506
+ limit: number;
17507
+ /** @default 1 */
17508
+ page: number;
17509
+ total: number;
17510
+ totalPage: number;
17511
+ nextPage?: number;
17512
+ };
17513
+ };
17514
+ };
17515
+ };
17516
+ /** @description Bad request */
17517
+ 400: {
17518
+ headers: {
17519
+ [name: string]: unknown;
17520
+ };
17521
+ content: {
17522
+ "application/json": {
17523
+ code: string;
17524
+ message: string;
17525
+ links?: {
17526
+ docs: string;
17527
+ schema: string;
17528
+ };
17529
+ issues?: {
17530
+ message: string;
17531
+ path?: (string | number)[];
17532
+ schema?: string;
17533
+ }[];
17534
+ context?: unknown;
17535
+ };
17536
+ };
17537
+ };
17538
+ /** @description Unauthorized */
17539
+ 401: {
17540
+ headers: {
17541
+ [name: string]: unknown;
17542
+ };
17543
+ content: {
17544
+ "application/json": {
17545
+ code: string;
17546
+ message: string;
17547
+ links?: {
17548
+ docs: string;
17549
+ schema: string;
17550
+ };
17551
+ issues?: {
17552
+ message: string;
17553
+ path?: (string | number)[];
17554
+ schema?: string;
17555
+ }[];
17556
+ context?: unknown;
17557
+ };
17558
+ };
17559
+ };
17560
+ /** @description Forbidden */
17561
+ 403: {
17562
+ headers: {
17563
+ [name: string]: unknown;
17564
+ };
17565
+ content: {
17566
+ "application/json": {
17567
+ code: string;
17568
+ message: string;
17569
+ links?: {
17570
+ docs: string;
17571
+ schema: string;
17572
+ };
17573
+ issues?: {
17574
+ message: string;
17575
+ path?: (string | number)[];
17576
+ schema?: string;
17577
+ }[];
17578
+ context?: unknown;
17579
+ };
17580
+ };
17581
+ };
17582
+ /** @description Not found */
17583
+ 404: {
17584
+ headers: {
17585
+ [name: string]: unknown;
17586
+ };
17587
+ content: {
17588
+ "application/json": {
17589
+ code: string;
17590
+ message: string;
17591
+ links?: {
17592
+ docs: string;
17593
+ schema: string;
17594
+ };
17595
+ issues?: {
17596
+ message: string;
17597
+ path?: (string | number)[];
17598
+ schema?: string;
17599
+ }[];
17600
+ context?: unknown;
17601
+ };
17602
+ };
17603
+ };
17604
+ /** @description Internal server error */
17605
+ 500: {
17606
+ headers: {
17607
+ [name: string]: unknown;
17608
+ };
17609
+ content: {
17610
+ "application/json": {
17611
+ code: string;
17612
+ message: string;
17613
+ links?: {
17614
+ docs: string;
17615
+ schema: string;
17616
+ };
17617
+ issues?: {
17618
+ message: string;
17619
+ path?: (string | number)[];
17620
+ schema?: string;
17621
+ }[];
17622
+ context?: unknown;
17623
+ };
17624
+ };
17625
+ };
17626
+ };
17627
+ };
17628
+ postFiles: {
17629
+ parameters: {
17630
+ query?: never;
17631
+ header?: never;
17632
+ path?: never;
17633
+ cookie?: never;
17634
+ };
17635
+ requestBody?: never;
17636
+ responses: {
17637
+ /** @description Successful response */
17638
+ 200: {
17639
+ headers: {
17640
+ [name: string]: unknown;
17641
+ };
17642
+ content: {
17643
+ "application/json": {
17644
+ /** Format: uuid */
17645
+ id: string;
17646
+ filename: string;
17647
+ /** @constant */
17648
+ type: "userUpload";
17649
+ startDate: string | null;
17650
+ endDate: string | null;
17651
+ /**
17652
+ * Format: date-time
17653
+ * @description Timestamp string with date, time, milliseconds, and timezone.
17654
+ * @example 2024-01-15T12:30:00.000+00:00
17655
+ */
17656
+ createdAt: string;
17657
+ contact: {
17658
+ /** Format: uuid */
17659
+ id: string;
17660
+ name?: string | null;
17661
+ firstName?: string | null;
17662
+ uniqueRef?: string | null;
17663
+ shortRef?: string | null;
17664
+ email?: string | null;
17665
+ /** @enum {string} */
17666
+ type: "owner" | "vendor";
17667
+ } | null;
17668
+ };
17669
+ };
17670
+ };
17671
+ /** @description Bad request */
17672
+ 400: {
17673
+ headers: {
17674
+ [name: string]: unknown;
17675
+ };
17676
+ content: {
17677
+ "application/json": {
17678
+ code: string;
17679
+ message: string;
17680
+ links?: {
17681
+ docs: string;
17682
+ schema: string;
17683
+ };
17684
+ issues?: {
17685
+ message: string;
17686
+ path?: (string | number)[];
17687
+ schema?: string;
17688
+ }[];
17689
+ context?: unknown;
17690
+ };
17691
+ };
17692
+ };
17693
+ /** @description Unauthorized */
17694
+ 401: {
17695
+ headers: {
17696
+ [name: string]: unknown;
17697
+ };
17698
+ content: {
17699
+ "application/json": {
17700
+ code: string;
17701
+ message: string;
17702
+ links?: {
17703
+ docs: string;
17704
+ schema: string;
17705
+ };
17706
+ issues?: {
17707
+ message: string;
17708
+ path?: (string | number)[];
17709
+ schema?: string;
17710
+ }[];
17711
+ context?: unknown;
17712
+ };
17713
+ };
17714
+ };
17715
+ /** @description Forbidden */
17716
+ 403: {
17717
+ headers: {
17718
+ [name: string]: unknown;
17719
+ };
17720
+ content: {
17721
+ "application/json": {
17722
+ code: string;
17723
+ message: string;
17724
+ links?: {
17725
+ docs: string;
17726
+ schema: string;
17727
+ };
17728
+ issues?: {
17729
+ message: string;
17730
+ path?: (string | number)[];
17731
+ schema?: string;
17732
+ }[];
17733
+ context?: unknown;
17734
+ };
17735
+ };
17736
+ };
17737
+ /** @description Not found */
17738
+ 404: {
17739
+ headers: {
17740
+ [name: string]: unknown;
17741
+ };
17742
+ content: {
17743
+ "application/json": {
17744
+ code: string;
17745
+ message: string;
17746
+ links?: {
17747
+ docs: string;
17748
+ schema: string;
17749
+ };
17750
+ issues?: {
17751
+ message: string;
17752
+ path?: (string | number)[];
17753
+ schema?: string;
17754
+ }[];
17755
+ context?: unknown;
17756
+ };
17757
+ };
17758
+ };
17759
+ /** @description Internal server error */
17760
+ 500: {
17761
+ headers: {
17762
+ [name: string]: unknown;
17763
+ };
17764
+ content: {
17765
+ "application/json": {
17766
+ code: string;
17767
+ message: string;
17768
+ links?: {
17769
+ docs: string;
17770
+ schema: string;
17771
+ };
17772
+ issues?: {
17773
+ message: string;
17774
+ path?: (string | number)[];
17775
+ schema?: string;
17776
+ }[];
17777
+ context?: unknown;
17778
+ };
17779
+ };
17780
+ };
17781
+ };
17782
+ };
17783
+ deleteFilesById: {
17784
+ parameters: {
17785
+ query?: never;
17786
+ header?: never;
17787
+ path: {
17788
+ id: string;
17789
+ };
17790
+ cookie?: never;
17791
+ };
17792
+ requestBody?: {
17793
+ content: {
17794
+ "application/json": Record<string, never>;
17795
+ };
17796
+ };
17797
+ responses: {
17798
+ /** @description Successful response */
17799
+ 200: {
17800
+ headers: {
17801
+ [name: string]: unknown;
17802
+ };
17803
+ content: {
17804
+ "application/json": {
17805
+ /** Format: uuid */
17806
+ id: string;
17807
+ };
17808
+ };
17809
+ };
17810
+ /** @description Bad request */
17811
+ 400: {
17812
+ headers: {
17813
+ [name: string]: unknown;
17814
+ };
17815
+ content: {
17816
+ "application/json": {
17817
+ code: string;
17818
+ message: string;
17819
+ links?: {
17820
+ docs: string;
17821
+ schema: string;
17822
+ };
17823
+ issues?: {
17824
+ message: string;
17825
+ path?: (string | number)[];
17826
+ schema?: string;
17827
+ }[];
17828
+ context?: unknown;
17829
+ };
17830
+ };
17831
+ };
17832
+ /** @description Unauthorized */
17833
+ 401: {
17834
+ headers: {
17835
+ [name: string]: unknown;
17836
+ };
17837
+ content: {
17838
+ "application/json": {
17839
+ code: string;
17840
+ message: string;
17841
+ links?: {
17842
+ docs: string;
17843
+ schema: string;
17844
+ };
17845
+ issues?: {
17846
+ message: string;
17847
+ path?: (string | number)[];
17848
+ schema?: string;
17849
+ }[];
17850
+ context?: unknown;
17851
+ };
17852
+ };
17853
+ };
17854
+ /** @description Forbidden */
17855
+ 403: {
17856
+ headers: {
17857
+ [name: string]: unknown;
17858
+ };
17859
+ content: {
17860
+ "application/json": {
17861
+ code: string;
17862
+ message: string;
17863
+ links?: {
17864
+ docs: string;
17865
+ schema: string;
17866
+ };
17867
+ issues?: {
17868
+ message: string;
17869
+ path?: (string | number)[];
17870
+ schema?: string;
17871
+ }[];
17872
+ context?: unknown;
17873
+ };
17874
+ };
17875
+ };
17876
+ /** @description Not found */
17877
+ 404: {
17878
+ headers: {
17879
+ [name: string]: unknown;
17880
+ };
17881
+ content: {
17882
+ "application/json": {
17883
+ code: string;
17884
+ message: string;
17885
+ links?: {
17886
+ docs: string;
17887
+ schema: string;
17888
+ };
17889
+ issues?: {
17890
+ message: string;
17891
+ path?: (string | number)[];
17892
+ schema?: string;
17893
+ }[];
17894
+ context?: unknown;
17895
+ };
17896
+ };
17897
+ };
17898
+ /** @description Internal server error */
17899
+ 500: {
17900
+ headers: {
17901
+ [name: string]: unknown;
17902
+ };
17903
+ content: {
17904
+ "application/json": {
17905
+ code: string;
17906
+ message: string;
17907
+ links?: {
17908
+ docs: string;
17909
+ schema: string;
17910
+ };
17911
+ issues?: {
17912
+ message: string;
17913
+ path?: (string | number)[];
17914
+ schema?: string;
17915
+ }[];
17916
+ context?: unknown;
17917
+ };
17918
+ };
17919
+ };
17920
+ };
17921
+ };
17922
+ patchFilesById: {
17923
+ parameters: {
17924
+ query?: never;
17925
+ header?: never;
17926
+ path: {
17927
+ id: string;
17928
+ };
17929
+ cookie?: never;
17930
+ };
17931
+ requestBody?: {
17932
+ content: {
17933
+ "application/json": {
17934
+ filename?: string;
17935
+ startDate?: string | null;
17936
+ endDate?: string | null;
17937
+ contactId?: string | null;
17938
+ };
17939
+ };
17940
+ };
17941
+ responses: {
17942
+ /** @description Successful response */
17943
+ 200: {
17944
+ headers: {
17945
+ [name: string]: unknown;
17946
+ };
17947
+ content: {
17948
+ "application/json": {
17949
+ /** Format: uuid */
17950
+ id: string;
17951
+ filename: string;
17952
+ /** @constant */
17953
+ type: "userUpload";
17954
+ startDate: string | null;
17955
+ endDate: string | null;
17956
+ /**
17957
+ * Format: date-time
17958
+ * @description Timestamp string with date, time, milliseconds, and timezone.
17959
+ * @example 2024-01-15T12:30:00.000+00:00
17960
+ */
17961
+ createdAt: string;
17962
+ contact: {
17963
+ /** Format: uuid */
17964
+ id: string;
17965
+ name?: string | null;
17966
+ firstName?: string | null;
17967
+ uniqueRef?: string | null;
17968
+ shortRef?: string | null;
17969
+ email?: string | null;
17970
+ /** @enum {string} */
17971
+ type: "owner" | "vendor";
17972
+ } | null;
17973
+ };
17974
+ };
17975
+ };
17976
+ /** @description Bad request */
17977
+ 400: {
17978
+ headers: {
17979
+ [name: string]: unknown;
17980
+ };
17981
+ content: {
17982
+ "application/json": {
17983
+ code: string;
17984
+ message: string;
17985
+ links?: {
17986
+ docs: string;
17987
+ schema: string;
17988
+ };
17989
+ issues?: {
17990
+ message: string;
17991
+ path?: (string | number)[];
17992
+ schema?: string;
17993
+ }[];
17994
+ context?: unknown;
17995
+ };
17996
+ };
17997
+ };
17998
+ /** @description Unauthorized */
17999
+ 401: {
18000
+ headers: {
18001
+ [name: string]: unknown;
18002
+ };
18003
+ content: {
18004
+ "application/json": {
18005
+ code: string;
18006
+ message: string;
18007
+ links?: {
18008
+ docs: string;
18009
+ schema: string;
18010
+ };
18011
+ issues?: {
18012
+ message: string;
18013
+ path?: (string | number)[];
18014
+ schema?: string;
18015
+ }[];
18016
+ context?: unknown;
18017
+ };
18018
+ };
18019
+ };
18020
+ /** @description Forbidden */
18021
+ 403: {
18022
+ headers: {
18023
+ [name: string]: unknown;
18024
+ };
18025
+ content: {
18026
+ "application/json": {
18027
+ code: string;
18028
+ message: string;
18029
+ links?: {
18030
+ docs: string;
18031
+ schema: string;
18032
+ };
18033
+ issues?: {
18034
+ message: string;
18035
+ path?: (string | number)[];
18036
+ schema?: string;
18037
+ }[];
18038
+ context?: unknown;
18039
+ };
18040
+ };
18041
+ };
18042
+ /** @description Not found */
18043
+ 404: {
18044
+ headers: {
18045
+ [name: string]: unknown;
18046
+ };
18047
+ content: {
18048
+ "application/json": {
18049
+ code: string;
18050
+ message: string;
18051
+ links?: {
18052
+ docs: string;
18053
+ schema: string;
18054
+ };
18055
+ issues?: {
18056
+ message: string;
18057
+ path?: (string | number)[];
18058
+ schema?: string;
18059
+ }[];
18060
+ context?: unknown;
18061
+ };
18062
+ };
18063
+ };
18064
+ /** @description Internal server error */
18065
+ 500: {
18066
+ headers: {
18067
+ [name: string]: unknown;
18068
+ };
18069
+ content: {
18070
+ "application/json": {
18071
+ code: string;
18072
+ message: string;
18073
+ links?: {
18074
+ docs: string;
18075
+ schema: string;
18076
+ };
18077
+ issues?: {
18078
+ message: string;
18079
+ path?: (string | number)[];
18080
+ schema?: string;
18081
+ }[];
18082
+ context?: unknown;
18083
+ };
18084
+ };
18085
+ };
18086
+ };
18087
+ };
18088
+ getFilesByIdDownload: {
18089
+ parameters: {
18090
+ query?: never;
18091
+ header?: never;
18092
+ path: {
18093
+ id: string;
18094
+ };
18095
+ cookie?: never;
18096
+ };
18097
+ requestBody?: never;
18098
+ responses: {
18099
+ /** @description Successful response */
18100
+ 200: {
18101
+ headers: {
18102
+ [name: string]: unknown;
18103
+ };
18104
+ content: {
18105
+ "application/json": {
18106
+ /** Format: uuid */
18107
+ id: string;
18108
+ };
18109
+ };
18110
+ };
18111
+ /** @description Bad request */
18112
+ 400: {
18113
+ headers: {
18114
+ [name: string]: unknown;
18115
+ };
18116
+ content: {
18117
+ "application/json": {
18118
+ code: string;
18119
+ message: string;
18120
+ links?: {
18121
+ docs: string;
18122
+ schema: string;
18123
+ };
18124
+ issues?: {
18125
+ message: string;
18126
+ path?: (string | number)[];
18127
+ schema?: string;
18128
+ }[];
18129
+ context?: unknown;
18130
+ };
18131
+ };
18132
+ };
18133
+ /** @description Unauthorized */
18134
+ 401: {
18135
+ headers: {
18136
+ [name: string]: unknown;
18137
+ };
18138
+ content: {
18139
+ "application/json": {
18140
+ code: string;
18141
+ message: string;
18142
+ links?: {
18143
+ docs: string;
18144
+ schema: string;
18145
+ };
18146
+ issues?: {
18147
+ message: string;
18148
+ path?: (string | number)[];
18149
+ schema?: string;
18150
+ }[];
18151
+ context?: unknown;
18152
+ };
18153
+ };
18154
+ };
18155
+ /** @description Forbidden */
18156
+ 403: {
18157
+ headers: {
18158
+ [name: string]: unknown;
18159
+ };
18160
+ content: {
18161
+ "application/json": {
18162
+ code: string;
18163
+ message: string;
18164
+ links?: {
18165
+ docs: string;
18166
+ schema: string;
18167
+ };
18168
+ issues?: {
18169
+ message: string;
18170
+ path?: (string | number)[];
18171
+ schema?: string;
18172
+ }[];
18173
+ context?: unknown;
18174
+ };
18175
+ };
18176
+ };
18177
+ /** @description Not found */
18178
+ 404: {
18179
+ headers: {
18180
+ [name: string]: unknown;
18181
+ };
18182
+ content: {
18183
+ "application/json": {
18184
+ code: string;
18185
+ message: string;
18186
+ links?: {
18187
+ docs: string;
18188
+ schema: string;
18189
+ };
18190
+ issues?: {
18191
+ message: string;
18192
+ path?: (string | number)[];
18193
+ schema?: string;
18194
+ }[];
18195
+ context?: unknown;
18196
+ };
18197
+ };
18198
+ };
18199
+ /** @description Internal server error */
18200
+ 500: {
18201
+ headers: {
18202
+ [name: string]: unknown;
18203
+ };
18204
+ content: {
18205
+ "application/json": {
18206
+ code: string;
18207
+ message: string;
18208
+ links?: {
18209
+ docs: string;
18210
+ schema: string;
18211
+ };
18212
+ issues?: {
18213
+ message: string;
18214
+ path?: (string | number)[];
18215
+ schema?: string;
18216
+ }[];
18217
+ context?: unknown;
18218
+ };
18219
+ };
18220
+ };
18221
+ };
18222
+ };
17402
18223
  getFlows: {
17403
18224
  parameters: {
17404
18225
  query?: {