@vrplatform/api 1.3.1-stage.2514 → 1.3.1-stage.2515
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.
|
@@ -747,6 +747,58 @@ export interface paths {
|
|
|
747
747
|
patch: operations["patchContactsByIdRevokeAccess"];
|
|
748
748
|
trace?: never;
|
|
749
749
|
};
|
|
750
|
+
"/contacts/{id}/viewers": {
|
|
751
|
+
parameters: {
|
|
752
|
+
query?: never;
|
|
753
|
+
header?: never;
|
|
754
|
+
path?: never;
|
|
755
|
+
cookie?: never;
|
|
756
|
+
};
|
|
757
|
+
/** @description List owner-viewer access for an owner contact */
|
|
758
|
+
get: operations["getContactsByIdViewers"];
|
|
759
|
+
put?: never;
|
|
760
|
+
/** @description Invite an owner viewer for an owner contact */
|
|
761
|
+
post: operations["postContactsByIdViewers"];
|
|
762
|
+
delete?: never;
|
|
763
|
+
options?: never;
|
|
764
|
+
head?: never;
|
|
765
|
+
patch?: never;
|
|
766
|
+
trace?: never;
|
|
767
|
+
};
|
|
768
|
+
"/contacts/{id}/viewers/{userId}": {
|
|
769
|
+
parameters: {
|
|
770
|
+
query?: never;
|
|
771
|
+
header?: never;
|
|
772
|
+
path?: never;
|
|
773
|
+
cookie?: never;
|
|
774
|
+
};
|
|
775
|
+
get?: never;
|
|
776
|
+
put?: never;
|
|
777
|
+
post?: never;
|
|
778
|
+
/** @description Remove an owner-viewer access row from an owner contact */
|
|
779
|
+
delete: operations["deleteContactsByIdViewersByUserId"];
|
|
780
|
+
options?: never;
|
|
781
|
+
head?: never;
|
|
782
|
+
patch?: never;
|
|
783
|
+
trace?: never;
|
|
784
|
+
};
|
|
785
|
+
"/contacts/{id}/viewers/{userId}/invite": {
|
|
786
|
+
parameters: {
|
|
787
|
+
query?: never;
|
|
788
|
+
header?: never;
|
|
789
|
+
path?: never;
|
|
790
|
+
cookie?: never;
|
|
791
|
+
};
|
|
792
|
+
get?: never;
|
|
793
|
+
put?: never;
|
|
794
|
+
post?: never;
|
|
795
|
+
delete?: never;
|
|
796
|
+
options?: never;
|
|
797
|
+
head?: never;
|
|
798
|
+
/** @description Reinvite an existing owner viewer */
|
|
799
|
+
patch: operations["patchContactsByIdViewersByUserIdInvite"];
|
|
800
|
+
trace?: never;
|
|
801
|
+
};
|
|
750
802
|
"/csv/import": {
|
|
751
803
|
parameters: {
|
|
752
804
|
query?: never;
|
|
@@ -12810,6 +12862,472 @@ export interface operations {
|
|
|
12810
12862
|
};
|
|
12811
12863
|
};
|
|
12812
12864
|
};
|
|
12865
|
+
getContactsByIdViewers: {
|
|
12866
|
+
parameters: {
|
|
12867
|
+
query?: never;
|
|
12868
|
+
header?: never;
|
|
12869
|
+
path: {
|
|
12870
|
+
id: string;
|
|
12871
|
+
};
|
|
12872
|
+
cookie?: never;
|
|
12873
|
+
};
|
|
12874
|
+
requestBody?: never;
|
|
12875
|
+
responses: {
|
|
12876
|
+
/** @description Successful response */
|
|
12877
|
+
200: {
|
|
12878
|
+
headers: {
|
|
12879
|
+
[name: string]: unknown;
|
|
12880
|
+
};
|
|
12881
|
+
content: {
|
|
12882
|
+
"application/json": {
|
|
12883
|
+
data: {
|
|
12884
|
+
/** Format: uuid */
|
|
12885
|
+
userId: string;
|
|
12886
|
+
email: string;
|
|
12887
|
+
firstName: string | null;
|
|
12888
|
+
lastName: string | null;
|
|
12889
|
+
/** @enum {string} */
|
|
12890
|
+
status: "active" | "inactive" | "unconfirmed";
|
|
12891
|
+
lastInvitedAt: string | null;
|
|
12892
|
+
lastSeen: string | null;
|
|
12893
|
+
}[];
|
|
12894
|
+
};
|
|
12895
|
+
};
|
|
12896
|
+
};
|
|
12897
|
+
/** @description Bad request */
|
|
12898
|
+
400: {
|
|
12899
|
+
headers: {
|
|
12900
|
+
[name: string]: unknown;
|
|
12901
|
+
};
|
|
12902
|
+
content: {
|
|
12903
|
+
"application/json": {
|
|
12904
|
+
code: string;
|
|
12905
|
+
message: string;
|
|
12906
|
+
issues?: {
|
|
12907
|
+
message: string;
|
|
12908
|
+
}[];
|
|
12909
|
+
context?: unknown;
|
|
12910
|
+
};
|
|
12911
|
+
};
|
|
12912
|
+
};
|
|
12913
|
+
/** @description Unauthorized */
|
|
12914
|
+
401: {
|
|
12915
|
+
headers: {
|
|
12916
|
+
[name: string]: unknown;
|
|
12917
|
+
};
|
|
12918
|
+
content: {
|
|
12919
|
+
"application/json": {
|
|
12920
|
+
code: string;
|
|
12921
|
+
message: string;
|
|
12922
|
+
issues?: {
|
|
12923
|
+
message: string;
|
|
12924
|
+
}[];
|
|
12925
|
+
context?: unknown;
|
|
12926
|
+
};
|
|
12927
|
+
};
|
|
12928
|
+
};
|
|
12929
|
+
/** @description Forbidden */
|
|
12930
|
+
403: {
|
|
12931
|
+
headers: {
|
|
12932
|
+
[name: string]: unknown;
|
|
12933
|
+
};
|
|
12934
|
+
content: {
|
|
12935
|
+
"application/json": {
|
|
12936
|
+
code: string;
|
|
12937
|
+
message: string;
|
|
12938
|
+
issues?: {
|
|
12939
|
+
message: string;
|
|
12940
|
+
}[];
|
|
12941
|
+
context?: unknown;
|
|
12942
|
+
};
|
|
12943
|
+
};
|
|
12944
|
+
};
|
|
12945
|
+
/** @description Not found */
|
|
12946
|
+
404: {
|
|
12947
|
+
headers: {
|
|
12948
|
+
[name: string]: unknown;
|
|
12949
|
+
};
|
|
12950
|
+
content: {
|
|
12951
|
+
"application/json": {
|
|
12952
|
+
code: string;
|
|
12953
|
+
message: string;
|
|
12954
|
+
issues?: {
|
|
12955
|
+
message: string;
|
|
12956
|
+
}[];
|
|
12957
|
+
context?: unknown;
|
|
12958
|
+
};
|
|
12959
|
+
};
|
|
12960
|
+
};
|
|
12961
|
+
/** @description Internal server error */
|
|
12962
|
+
500: {
|
|
12963
|
+
headers: {
|
|
12964
|
+
[name: string]: unknown;
|
|
12965
|
+
};
|
|
12966
|
+
content: {
|
|
12967
|
+
"application/json": {
|
|
12968
|
+
code: string;
|
|
12969
|
+
message: string;
|
|
12970
|
+
issues?: {
|
|
12971
|
+
message: string;
|
|
12972
|
+
}[];
|
|
12973
|
+
context?: unknown;
|
|
12974
|
+
};
|
|
12975
|
+
};
|
|
12976
|
+
};
|
|
12977
|
+
};
|
|
12978
|
+
};
|
|
12979
|
+
postContactsByIdViewers: {
|
|
12980
|
+
parameters: {
|
|
12981
|
+
query?: never;
|
|
12982
|
+
header?: never;
|
|
12983
|
+
path: {
|
|
12984
|
+
id: string;
|
|
12985
|
+
};
|
|
12986
|
+
cookie?: never;
|
|
12987
|
+
};
|
|
12988
|
+
requestBody?: {
|
|
12989
|
+
content: {
|
|
12990
|
+
"application/json": {
|
|
12991
|
+
email: string;
|
|
12992
|
+
/** @default true */
|
|
12993
|
+
sendEmail?: boolean;
|
|
12994
|
+
};
|
|
12995
|
+
};
|
|
12996
|
+
};
|
|
12997
|
+
responses: {
|
|
12998
|
+
/** @description Successful response */
|
|
12999
|
+
200: {
|
|
13000
|
+
headers: {
|
|
13001
|
+
[name: string]: unknown;
|
|
13002
|
+
};
|
|
13003
|
+
content: {
|
|
13004
|
+
"application/json": {
|
|
13005
|
+
url: string;
|
|
13006
|
+
viewer: {
|
|
13007
|
+
/** Format: uuid */
|
|
13008
|
+
userId: string;
|
|
13009
|
+
email: string;
|
|
13010
|
+
firstName: string | null;
|
|
13011
|
+
lastName: string | null;
|
|
13012
|
+
/** @enum {string} */
|
|
13013
|
+
status: "active" | "inactive" | "unconfirmed";
|
|
13014
|
+
lastInvitedAt: string | null;
|
|
13015
|
+
lastSeen: string | null;
|
|
13016
|
+
};
|
|
13017
|
+
};
|
|
13018
|
+
};
|
|
13019
|
+
};
|
|
13020
|
+
/** @description Bad request */
|
|
13021
|
+
400: {
|
|
13022
|
+
headers: {
|
|
13023
|
+
[name: string]: unknown;
|
|
13024
|
+
};
|
|
13025
|
+
content: {
|
|
13026
|
+
"application/json": {
|
|
13027
|
+
code: string;
|
|
13028
|
+
message: string;
|
|
13029
|
+
issues?: {
|
|
13030
|
+
message: string;
|
|
13031
|
+
}[];
|
|
13032
|
+
context?: unknown;
|
|
13033
|
+
};
|
|
13034
|
+
};
|
|
13035
|
+
};
|
|
13036
|
+
/** @description Unauthorized */
|
|
13037
|
+
401: {
|
|
13038
|
+
headers: {
|
|
13039
|
+
[name: string]: unknown;
|
|
13040
|
+
};
|
|
13041
|
+
content: {
|
|
13042
|
+
"application/json": {
|
|
13043
|
+
code: string;
|
|
13044
|
+
message: string;
|
|
13045
|
+
issues?: {
|
|
13046
|
+
message: string;
|
|
13047
|
+
}[];
|
|
13048
|
+
context?: unknown;
|
|
13049
|
+
};
|
|
13050
|
+
};
|
|
13051
|
+
};
|
|
13052
|
+
/** @description Forbidden */
|
|
13053
|
+
403: {
|
|
13054
|
+
headers: {
|
|
13055
|
+
[name: string]: unknown;
|
|
13056
|
+
};
|
|
13057
|
+
content: {
|
|
13058
|
+
"application/json": {
|
|
13059
|
+
code: string;
|
|
13060
|
+
message: string;
|
|
13061
|
+
issues?: {
|
|
13062
|
+
message: string;
|
|
13063
|
+
}[];
|
|
13064
|
+
context?: unknown;
|
|
13065
|
+
};
|
|
13066
|
+
};
|
|
13067
|
+
};
|
|
13068
|
+
/** @description Not found */
|
|
13069
|
+
404: {
|
|
13070
|
+
headers: {
|
|
13071
|
+
[name: string]: unknown;
|
|
13072
|
+
};
|
|
13073
|
+
content: {
|
|
13074
|
+
"application/json": {
|
|
13075
|
+
code: string;
|
|
13076
|
+
message: string;
|
|
13077
|
+
issues?: {
|
|
13078
|
+
message: string;
|
|
13079
|
+
}[];
|
|
13080
|
+
context?: unknown;
|
|
13081
|
+
};
|
|
13082
|
+
};
|
|
13083
|
+
};
|
|
13084
|
+
/** @description Internal server error */
|
|
13085
|
+
500: {
|
|
13086
|
+
headers: {
|
|
13087
|
+
[name: string]: unknown;
|
|
13088
|
+
};
|
|
13089
|
+
content: {
|
|
13090
|
+
"application/json": {
|
|
13091
|
+
code: string;
|
|
13092
|
+
message: string;
|
|
13093
|
+
issues?: {
|
|
13094
|
+
message: string;
|
|
13095
|
+
}[];
|
|
13096
|
+
context?: unknown;
|
|
13097
|
+
};
|
|
13098
|
+
};
|
|
13099
|
+
};
|
|
13100
|
+
};
|
|
13101
|
+
};
|
|
13102
|
+
deleteContactsByIdViewersByUserId: {
|
|
13103
|
+
parameters: {
|
|
13104
|
+
query?: never;
|
|
13105
|
+
header?: never;
|
|
13106
|
+
path: {
|
|
13107
|
+
id: string;
|
|
13108
|
+
userId: string;
|
|
13109
|
+
};
|
|
13110
|
+
cookie?: never;
|
|
13111
|
+
};
|
|
13112
|
+
requestBody?: never;
|
|
13113
|
+
responses: {
|
|
13114
|
+
/** @description Successful response */
|
|
13115
|
+
200: {
|
|
13116
|
+
headers: {
|
|
13117
|
+
[name: string]: unknown;
|
|
13118
|
+
};
|
|
13119
|
+
content: {
|
|
13120
|
+
"application/json": {
|
|
13121
|
+
/** @constant */
|
|
13122
|
+
status: "deleted";
|
|
13123
|
+
};
|
|
13124
|
+
};
|
|
13125
|
+
};
|
|
13126
|
+
/** @description Bad request */
|
|
13127
|
+
400: {
|
|
13128
|
+
headers: {
|
|
13129
|
+
[name: string]: unknown;
|
|
13130
|
+
};
|
|
13131
|
+
content: {
|
|
13132
|
+
"application/json": {
|
|
13133
|
+
code: string;
|
|
13134
|
+
message: string;
|
|
13135
|
+
issues?: {
|
|
13136
|
+
message: string;
|
|
13137
|
+
}[];
|
|
13138
|
+
context?: unknown;
|
|
13139
|
+
};
|
|
13140
|
+
};
|
|
13141
|
+
};
|
|
13142
|
+
/** @description Unauthorized */
|
|
13143
|
+
401: {
|
|
13144
|
+
headers: {
|
|
13145
|
+
[name: string]: unknown;
|
|
13146
|
+
};
|
|
13147
|
+
content: {
|
|
13148
|
+
"application/json": {
|
|
13149
|
+
code: string;
|
|
13150
|
+
message: string;
|
|
13151
|
+
issues?: {
|
|
13152
|
+
message: string;
|
|
13153
|
+
}[];
|
|
13154
|
+
context?: unknown;
|
|
13155
|
+
};
|
|
13156
|
+
};
|
|
13157
|
+
};
|
|
13158
|
+
/** @description Forbidden */
|
|
13159
|
+
403: {
|
|
13160
|
+
headers: {
|
|
13161
|
+
[name: string]: unknown;
|
|
13162
|
+
};
|
|
13163
|
+
content: {
|
|
13164
|
+
"application/json": {
|
|
13165
|
+
code: string;
|
|
13166
|
+
message: string;
|
|
13167
|
+
issues?: {
|
|
13168
|
+
message: string;
|
|
13169
|
+
}[];
|
|
13170
|
+
context?: unknown;
|
|
13171
|
+
};
|
|
13172
|
+
};
|
|
13173
|
+
};
|
|
13174
|
+
/** @description Not found */
|
|
13175
|
+
404: {
|
|
13176
|
+
headers: {
|
|
13177
|
+
[name: string]: unknown;
|
|
13178
|
+
};
|
|
13179
|
+
content: {
|
|
13180
|
+
"application/json": {
|
|
13181
|
+
code: string;
|
|
13182
|
+
message: string;
|
|
13183
|
+
issues?: {
|
|
13184
|
+
message: string;
|
|
13185
|
+
}[];
|
|
13186
|
+
context?: unknown;
|
|
13187
|
+
};
|
|
13188
|
+
};
|
|
13189
|
+
};
|
|
13190
|
+
/** @description Internal server error */
|
|
13191
|
+
500: {
|
|
13192
|
+
headers: {
|
|
13193
|
+
[name: string]: unknown;
|
|
13194
|
+
};
|
|
13195
|
+
content: {
|
|
13196
|
+
"application/json": {
|
|
13197
|
+
code: string;
|
|
13198
|
+
message: string;
|
|
13199
|
+
issues?: {
|
|
13200
|
+
message: string;
|
|
13201
|
+
}[];
|
|
13202
|
+
context?: unknown;
|
|
13203
|
+
};
|
|
13204
|
+
};
|
|
13205
|
+
};
|
|
13206
|
+
};
|
|
13207
|
+
};
|
|
13208
|
+
patchContactsByIdViewersByUserIdInvite: {
|
|
13209
|
+
parameters: {
|
|
13210
|
+
query?: never;
|
|
13211
|
+
header?: never;
|
|
13212
|
+
path: {
|
|
13213
|
+
id: string;
|
|
13214
|
+
userId: string;
|
|
13215
|
+
};
|
|
13216
|
+
cookie?: never;
|
|
13217
|
+
};
|
|
13218
|
+
requestBody?: {
|
|
13219
|
+
content: {
|
|
13220
|
+
"application/json": {
|
|
13221
|
+
/** @default true */
|
|
13222
|
+
sendEmail?: boolean;
|
|
13223
|
+
};
|
|
13224
|
+
};
|
|
13225
|
+
};
|
|
13226
|
+
responses: {
|
|
13227
|
+
/** @description Successful response */
|
|
13228
|
+
200: {
|
|
13229
|
+
headers: {
|
|
13230
|
+
[name: string]: unknown;
|
|
13231
|
+
};
|
|
13232
|
+
content: {
|
|
13233
|
+
"application/json": {
|
|
13234
|
+
url: string;
|
|
13235
|
+
viewer: {
|
|
13236
|
+
/** Format: uuid */
|
|
13237
|
+
userId: string;
|
|
13238
|
+
email: string;
|
|
13239
|
+
firstName: string | null;
|
|
13240
|
+
lastName: string | null;
|
|
13241
|
+
/** @enum {string} */
|
|
13242
|
+
status: "active" | "inactive" | "unconfirmed";
|
|
13243
|
+
lastInvitedAt: string | null;
|
|
13244
|
+
lastSeen: string | null;
|
|
13245
|
+
};
|
|
13246
|
+
};
|
|
13247
|
+
};
|
|
13248
|
+
};
|
|
13249
|
+
/** @description Bad request */
|
|
13250
|
+
400: {
|
|
13251
|
+
headers: {
|
|
13252
|
+
[name: string]: unknown;
|
|
13253
|
+
};
|
|
13254
|
+
content: {
|
|
13255
|
+
"application/json": {
|
|
13256
|
+
code: string;
|
|
13257
|
+
message: string;
|
|
13258
|
+
issues?: {
|
|
13259
|
+
message: string;
|
|
13260
|
+
}[];
|
|
13261
|
+
context?: unknown;
|
|
13262
|
+
};
|
|
13263
|
+
};
|
|
13264
|
+
};
|
|
13265
|
+
/** @description Unauthorized */
|
|
13266
|
+
401: {
|
|
13267
|
+
headers: {
|
|
13268
|
+
[name: string]: unknown;
|
|
13269
|
+
};
|
|
13270
|
+
content: {
|
|
13271
|
+
"application/json": {
|
|
13272
|
+
code: string;
|
|
13273
|
+
message: string;
|
|
13274
|
+
issues?: {
|
|
13275
|
+
message: string;
|
|
13276
|
+
}[];
|
|
13277
|
+
context?: unknown;
|
|
13278
|
+
};
|
|
13279
|
+
};
|
|
13280
|
+
};
|
|
13281
|
+
/** @description Forbidden */
|
|
13282
|
+
403: {
|
|
13283
|
+
headers: {
|
|
13284
|
+
[name: string]: unknown;
|
|
13285
|
+
};
|
|
13286
|
+
content: {
|
|
13287
|
+
"application/json": {
|
|
13288
|
+
code: string;
|
|
13289
|
+
message: string;
|
|
13290
|
+
issues?: {
|
|
13291
|
+
message: string;
|
|
13292
|
+
}[];
|
|
13293
|
+
context?: unknown;
|
|
13294
|
+
};
|
|
13295
|
+
};
|
|
13296
|
+
};
|
|
13297
|
+
/** @description Not found */
|
|
13298
|
+
404: {
|
|
13299
|
+
headers: {
|
|
13300
|
+
[name: string]: unknown;
|
|
13301
|
+
};
|
|
13302
|
+
content: {
|
|
13303
|
+
"application/json": {
|
|
13304
|
+
code: string;
|
|
13305
|
+
message: string;
|
|
13306
|
+
issues?: {
|
|
13307
|
+
message: string;
|
|
13308
|
+
}[];
|
|
13309
|
+
context?: unknown;
|
|
13310
|
+
};
|
|
13311
|
+
};
|
|
13312
|
+
};
|
|
13313
|
+
/** @description Internal server error */
|
|
13314
|
+
500: {
|
|
13315
|
+
headers: {
|
|
13316
|
+
[name: string]: unknown;
|
|
13317
|
+
};
|
|
13318
|
+
content: {
|
|
13319
|
+
"application/json": {
|
|
13320
|
+
code: string;
|
|
13321
|
+
message: string;
|
|
13322
|
+
issues?: {
|
|
13323
|
+
message: string;
|
|
13324
|
+
}[];
|
|
13325
|
+
context?: unknown;
|
|
13326
|
+
};
|
|
13327
|
+
};
|
|
13328
|
+
};
|
|
13329
|
+
};
|
|
13330
|
+
};
|
|
12813
13331
|
csvImport: {
|
|
12814
13332
|
parameters: {
|
|
12815
13333
|
query?: never;
|
|
@@ -18538,6 +19056,8 @@ export interface operations {
|
|
|
18538
19056
|
ownerId?: string;
|
|
18539
19057
|
/** Format: uuid */
|
|
18540
19058
|
teamId: string;
|
|
19059
|
+
/** @enum {string} */
|
|
19060
|
+
role: "admin" | "viewer";
|
|
18541
19061
|
}[];
|
|
18542
19062
|
teamAccess: {
|
|
18543
19063
|
/** Format: uuid */
|