@finueva/drive 0.30.0 → 0.31.0
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/CHANGELOG.md +6 -0
- package/dist/client.d.ts +2 -2
- package/dist/client.js +1 -1
- package/dist/contract.d.ts +607 -8
- package/dist/core.d.ts +1 -1
- package/dist/core.js +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/server.d.ts +2 -2
- package/dist/server.js +1 -1
- package/dist/types.d.ts +2 -2
- package/package.json +1 -1
package/dist/contract.d.ts
CHANGED
|
@@ -1886,6 +1886,156 @@ interface operations {
|
|
|
1886
1886
|
};
|
|
1887
1887
|
};
|
|
1888
1888
|
};
|
|
1889
|
+
getWorkspaceCounts: {
|
|
1890
|
+
parameters: {
|
|
1891
|
+
query?: never;
|
|
1892
|
+
header?: never;
|
|
1893
|
+
path: {
|
|
1894
|
+
workspaceId: string;
|
|
1895
|
+
};
|
|
1896
|
+
cookie?: never;
|
|
1897
|
+
};
|
|
1898
|
+
requestBody?: never;
|
|
1899
|
+
responses: {
|
|
1900
|
+
/** @description Bounded counts; never a count of items the caller cannot list. */
|
|
1901
|
+
200: {
|
|
1902
|
+
headers: {
|
|
1903
|
+
[name: string]: unknown;
|
|
1904
|
+
};
|
|
1905
|
+
content: {
|
|
1906
|
+
"application/json": {
|
|
1907
|
+
/** @enum {number} */
|
|
1908
|
+
ceiling: 999;
|
|
1909
|
+
counts: {
|
|
1910
|
+
allItems?: {
|
|
1911
|
+
capped: boolean;
|
|
1912
|
+
value: number;
|
|
1913
|
+
};
|
|
1914
|
+
favorites?: {
|
|
1915
|
+
capped: boolean;
|
|
1916
|
+
value: number;
|
|
1917
|
+
};
|
|
1918
|
+
media?: {
|
|
1919
|
+
capped: boolean;
|
|
1920
|
+
value: number;
|
|
1921
|
+
};
|
|
1922
|
+
sharedWithMe?: {
|
|
1923
|
+
capped: boolean;
|
|
1924
|
+
value: number;
|
|
1925
|
+
};
|
|
1926
|
+
trash?: {
|
|
1927
|
+
capped: boolean;
|
|
1928
|
+
value: number;
|
|
1929
|
+
};
|
|
1930
|
+
};
|
|
1931
|
+
workspaceId: string;
|
|
1932
|
+
};
|
|
1933
|
+
};
|
|
1934
|
+
};
|
|
1935
|
+
/** @description Authentication required. */
|
|
1936
|
+
401: {
|
|
1937
|
+
headers: {
|
|
1938
|
+
[name: string]: unknown;
|
|
1939
|
+
};
|
|
1940
|
+
content: {
|
|
1941
|
+
"application/json": {
|
|
1942
|
+
error: {
|
|
1943
|
+
/** @enum {string} */
|
|
1944
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
1945
|
+
details: Record<string, never>;
|
|
1946
|
+
message: string;
|
|
1947
|
+
requestId: string;
|
|
1948
|
+
};
|
|
1949
|
+
};
|
|
1950
|
+
};
|
|
1951
|
+
};
|
|
1952
|
+
/** @description The action is not permitted. */
|
|
1953
|
+
403: {
|
|
1954
|
+
headers: {
|
|
1955
|
+
[name: string]: unknown;
|
|
1956
|
+
};
|
|
1957
|
+
content: {
|
|
1958
|
+
"application/json": {
|
|
1959
|
+
error: {
|
|
1960
|
+
/** @enum {string} */
|
|
1961
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
1962
|
+
details: Record<string, never>;
|
|
1963
|
+
message: string;
|
|
1964
|
+
requestId: string;
|
|
1965
|
+
};
|
|
1966
|
+
};
|
|
1967
|
+
};
|
|
1968
|
+
};
|
|
1969
|
+
/** @description Workspace not found. */
|
|
1970
|
+
404: {
|
|
1971
|
+
headers: {
|
|
1972
|
+
[name: string]: unknown;
|
|
1973
|
+
};
|
|
1974
|
+
content: {
|
|
1975
|
+
"application/json": {
|
|
1976
|
+
error: {
|
|
1977
|
+
/** @enum {string} */
|
|
1978
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
1979
|
+
details: Record<string, never>;
|
|
1980
|
+
message: string;
|
|
1981
|
+
requestId: string;
|
|
1982
|
+
};
|
|
1983
|
+
};
|
|
1984
|
+
};
|
|
1985
|
+
};
|
|
1986
|
+
/** @description The selected authority or page changed; restart the query. */
|
|
1987
|
+
409: {
|
|
1988
|
+
headers: {
|
|
1989
|
+
[name: string]: unknown;
|
|
1990
|
+
};
|
|
1991
|
+
content: {
|
|
1992
|
+
"application/json": {
|
|
1993
|
+
error: {
|
|
1994
|
+
/** @enum {string} */
|
|
1995
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
1996
|
+
details: Record<string, never>;
|
|
1997
|
+
message: string;
|
|
1998
|
+
requestId: string;
|
|
1999
|
+
};
|
|
2000
|
+
};
|
|
2001
|
+
};
|
|
2002
|
+
};
|
|
2003
|
+
/** @description Invalid request or cursor. */
|
|
2004
|
+
422: {
|
|
2005
|
+
headers: {
|
|
2006
|
+
[name: string]: unknown;
|
|
2007
|
+
};
|
|
2008
|
+
content: {
|
|
2009
|
+
"application/json": {
|
|
2010
|
+
error: {
|
|
2011
|
+
/** @enum {string} */
|
|
2012
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
2013
|
+
details: Record<string, never>;
|
|
2014
|
+
message: string;
|
|
2015
|
+
requestId: string;
|
|
2016
|
+
};
|
|
2017
|
+
};
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
/** @description Authoritative state is unavailable. */
|
|
2021
|
+
503: {
|
|
2022
|
+
headers: {
|
|
2023
|
+
[name: string]: unknown;
|
|
2024
|
+
};
|
|
2025
|
+
content: {
|
|
2026
|
+
"application/json": {
|
|
2027
|
+
error: {
|
|
2028
|
+
/** @enum {string} */
|
|
2029
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
2030
|
+
details: Record<string, never>;
|
|
2031
|
+
message: string;
|
|
2032
|
+
requestId: string;
|
|
2033
|
+
};
|
|
2034
|
+
};
|
|
2035
|
+
};
|
|
2036
|
+
};
|
|
2037
|
+
};
|
|
2038
|
+
};
|
|
1889
2039
|
changeEditingSession: {
|
|
1890
2040
|
parameters: {
|
|
1891
2041
|
query?: never;
|
|
@@ -1962,14 +2112,174 @@ interface operations {
|
|
|
1962
2112
|
headers: {
|
|
1963
2113
|
[name: string]: unknown;
|
|
1964
2114
|
};
|
|
1965
|
-
content?: never;
|
|
2115
|
+
content?: never;
|
|
2116
|
+
};
|
|
2117
|
+
/** @description Persistence unavailable. */
|
|
2118
|
+
503: {
|
|
2119
|
+
headers: {
|
|
2120
|
+
[name: string]: unknown;
|
|
2121
|
+
};
|
|
2122
|
+
content?: never;
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
2125
|
+
};
|
|
2126
|
+
listFavoriteItems: {
|
|
2127
|
+
parameters: {
|
|
2128
|
+
query?: {
|
|
2129
|
+
limit?: number;
|
|
2130
|
+
cursor?: string;
|
|
2131
|
+
};
|
|
2132
|
+
header?: never;
|
|
2133
|
+
path: {
|
|
2134
|
+
workspaceId: string;
|
|
2135
|
+
};
|
|
2136
|
+
cookie?: never;
|
|
2137
|
+
};
|
|
2138
|
+
requestBody?: never;
|
|
2139
|
+
responses: {
|
|
2140
|
+
/** @description Starred items in item order with an authenticated continuation; every item carries `favorite: true`. */
|
|
2141
|
+
200: {
|
|
2142
|
+
headers: {
|
|
2143
|
+
[name: string]: unknown;
|
|
2144
|
+
};
|
|
2145
|
+
content: {
|
|
2146
|
+
"application/json": {
|
|
2147
|
+
items: {
|
|
2148
|
+
createdAtEpochMilliseconds: number | null;
|
|
2149
|
+
creatorUserId: string | null;
|
|
2150
|
+
currentVersion: {
|
|
2151
|
+
byteLength: number;
|
|
2152
|
+
mediaType: string;
|
|
2153
|
+
/** @enum {string} */
|
|
2154
|
+
protectionClassification: "ordinary" | "opaque-encrypted";
|
|
2155
|
+
/** @enum {string} */
|
|
2156
|
+
state: "current";
|
|
2157
|
+
versionId: string;
|
|
2158
|
+
} | null;
|
|
2159
|
+
etag: string;
|
|
2160
|
+
/** @description Whether the caller starred the item. Present only when requested with `include=favorite` and always on favorite pages. */
|
|
2161
|
+
favorite?: boolean;
|
|
2162
|
+
itemId: string;
|
|
2163
|
+
/** @enum {string} */
|
|
2164
|
+
lifecycleState: "active" | "trashed";
|
|
2165
|
+
modifiedAtEpochMilliseconds: number | null;
|
|
2166
|
+
name: string;
|
|
2167
|
+
parentId: string | null;
|
|
2168
|
+
/** @enum {string} */
|
|
2169
|
+
provider: "managed";
|
|
2170
|
+
purgeAfterEpochMilliseconds: number | null;
|
|
2171
|
+
revision: number;
|
|
2172
|
+
trashedAtEpochMilliseconds: number | null;
|
|
2173
|
+
/** @enum {string} */
|
|
2174
|
+
type: "file" | "folder";
|
|
2175
|
+
volumeId: string;
|
|
2176
|
+
workspaceId: string;
|
|
2177
|
+
}[];
|
|
2178
|
+
nextCursor: string | null;
|
|
2179
|
+
};
|
|
2180
|
+
};
|
|
2181
|
+
};
|
|
2182
|
+
/** @description Authentication required. */
|
|
2183
|
+
401: {
|
|
2184
|
+
headers: {
|
|
2185
|
+
[name: string]: unknown;
|
|
2186
|
+
};
|
|
2187
|
+
content: {
|
|
2188
|
+
"application/json": {
|
|
2189
|
+
error: {
|
|
2190
|
+
/** @enum {string} */
|
|
2191
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
2192
|
+
details: Record<string, never>;
|
|
2193
|
+
message: string;
|
|
2194
|
+
requestId: string;
|
|
2195
|
+
};
|
|
2196
|
+
};
|
|
2197
|
+
};
|
|
2198
|
+
};
|
|
2199
|
+
/** @description The action is not permitted. */
|
|
2200
|
+
403: {
|
|
2201
|
+
headers: {
|
|
2202
|
+
[name: string]: unknown;
|
|
2203
|
+
};
|
|
2204
|
+
content: {
|
|
2205
|
+
"application/json": {
|
|
2206
|
+
error: {
|
|
2207
|
+
/** @enum {string} */
|
|
2208
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
2209
|
+
details: Record<string, never>;
|
|
2210
|
+
message: string;
|
|
2211
|
+
requestId: string;
|
|
2212
|
+
};
|
|
2213
|
+
};
|
|
2214
|
+
};
|
|
2215
|
+
};
|
|
2216
|
+
/** @description Workspace not found. */
|
|
2217
|
+
404: {
|
|
2218
|
+
headers: {
|
|
2219
|
+
[name: string]: unknown;
|
|
2220
|
+
};
|
|
2221
|
+
content: {
|
|
2222
|
+
"application/json": {
|
|
2223
|
+
error: {
|
|
2224
|
+
/** @enum {string} */
|
|
2225
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
2226
|
+
details: Record<string, never>;
|
|
2227
|
+
message: string;
|
|
2228
|
+
requestId: string;
|
|
2229
|
+
};
|
|
2230
|
+
};
|
|
2231
|
+
};
|
|
2232
|
+
};
|
|
2233
|
+
/** @description The selected authority or page changed; restart the query. */
|
|
2234
|
+
409: {
|
|
2235
|
+
headers: {
|
|
2236
|
+
[name: string]: unknown;
|
|
2237
|
+
};
|
|
2238
|
+
content: {
|
|
2239
|
+
"application/json": {
|
|
2240
|
+
error: {
|
|
2241
|
+
/** @enum {string} */
|
|
2242
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
2243
|
+
details: Record<string, never>;
|
|
2244
|
+
message: string;
|
|
2245
|
+
requestId: string;
|
|
2246
|
+
};
|
|
2247
|
+
};
|
|
2248
|
+
};
|
|
2249
|
+
};
|
|
2250
|
+
/** @description Invalid request or cursor. */
|
|
2251
|
+
422: {
|
|
2252
|
+
headers: {
|
|
2253
|
+
[name: string]: unknown;
|
|
2254
|
+
};
|
|
2255
|
+
content: {
|
|
2256
|
+
"application/json": {
|
|
2257
|
+
error: {
|
|
2258
|
+
/** @enum {string} */
|
|
2259
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
2260
|
+
details: Record<string, never>;
|
|
2261
|
+
message: string;
|
|
2262
|
+
requestId: string;
|
|
2263
|
+
};
|
|
2264
|
+
};
|
|
2265
|
+
};
|
|
1966
2266
|
};
|
|
1967
|
-
/** @description
|
|
2267
|
+
/** @description Authoritative state is unavailable. */
|
|
1968
2268
|
503: {
|
|
1969
2269
|
headers: {
|
|
1970
2270
|
[name: string]: unknown;
|
|
1971
2271
|
};
|
|
1972
|
-
content
|
|
2272
|
+
content: {
|
|
2273
|
+
"application/json": {
|
|
2274
|
+
error: {
|
|
2275
|
+
/** @enum {string} */
|
|
2276
|
+
code: "authentication_required" | "identity_authority_unavailable" | "permission_denied" | "resource_not_found" | "invalid_request" | "invalid_pagination_cursor" | "precondition_failed" | "service_unavailable";
|
|
2277
|
+
details: Record<string, never>;
|
|
2278
|
+
message: string;
|
|
2279
|
+
requestId: string;
|
|
2280
|
+
};
|
|
2281
|
+
};
|
|
2282
|
+
};
|
|
1973
2283
|
};
|
|
1974
2284
|
};
|
|
1975
2285
|
};
|
|
@@ -1981,6 +2291,8 @@ interface operations {
|
|
|
1981
2291
|
creatorUserId?: string;
|
|
1982
2292
|
/** @description Comma-separated exact lowercase media types (1–32 unique values). Matches published current file versions, not filename extensions. */
|
|
1983
2293
|
mediaTypes?: string;
|
|
2294
|
+
/** @description Project the caller's private star on each item. */
|
|
2295
|
+
include?: "favorite";
|
|
1984
2296
|
limit?: number;
|
|
1985
2297
|
cursor?: string;
|
|
1986
2298
|
};
|
|
@@ -2012,6 +2324,8 @@ interface operations {
|
|
|
2012
2324
|
versionId: string;
|
|
2013
2325
|
} | null;
|
|
2014
2326
|
etag: string;
|
|
2327
|
+
/** @description Whether the caller starred the item. Present only when requested with `include=favorite` and always on favorite pages. */
|
|
2328
|
+
favorite?: boolean;
|
|
2015
2329
|
itemId: string;
|
|
2016
2330
|
/** @enum {string} */
|
|
2017
2331
|
lifecycleState: "active" | "trashed";
|
|
@@ -2915,8 +3229,8 @@ interface operations {
|
|
|
2915
3229
|
query?: {
|
|
2916
3230
|
limit?: number;
|
|
2917
3231
|
cursor?: string;
|
|
2918
|
-
/** @description Opt in to current version size and type, creation and modification time, creator, and effective owner on every item. Absent keeps the minimal item shape. */
|
|
2919
|
-
include?: "metadata";
|
|
3232
|
+
/** @description Opt in to current version size and type, creation and modification time, creator, and effective owner (`metadata`) and to the caller's private star (`favorite`) on every item. Absent keeps the minimal item shape. */
|
|
3233
|
+
include?: "metadata" | "favorite" | "favorite,metadata" | "metadata,favorite";
|
|
2920
3234
|
};
|
|
2921
3235
|
header?: never;
|
|
2922
3236
|
path: {
|
|
@@ -2946,6 +3260,8 @@ interface operations {
|
|
|
2946
3260
|
state: "current";
|
|
2947
3261
|
versionId: string;
|
|
2948
3262
|
} | null;
|
|
3263
|
+
/** @description The caller's private star; present with `include=favorite`. */
|
|
3264
|
+
favorite?: boolean;
|
|
2949
3265
|
itemId: string;
|
|
2950
3266
|
/** @enum {string} */
|
|
2951
3267
|
kind: "file" | "folder";
|
|
@@ -3624,6 +3940,260 @@ interface operations {
|
|
|
3624
3940
|
};
|
|
3625
3941
|
};
|
|
3626
3942
|
};
|
|
3943
|
+
starItem: {
|
|
3944
|
+
parameters: {
|
|
3945
|
+
query?: never;
|
|
3946
|
+
header?: never;
|
|
3947
|
+
path: {
|
|
3948
|
+
workspaceId: string;
|
|
3949
|
+
itemId: string;
|
|
3950
|
+
};
|
|
3951
|
+
cookie?: never;
|
|
3952
|
+
};
|
|
3953
|
+
requestBody?: never;
|
|
3954
|
+
responses: {
|
|
3955
|
+
/** @description The item is starred. */
|
|
3956
|
+
200: {
|
|
3957
|
+
headers: {
|
|
3958
|
+
[name: string]: unknown;
|
|
3959
|
+
};
|
|
3960
|
+
content: {
|
|
3961
|
+
"application/json": {
|
|
3962
|
+
favorite: boolean;
|
|
3963
|
+
itemId: string;
|
|
3964
|
+
workspaceId: string;
|
|
3965
|
+
};
|
|
3966
|
+
};
|
|
3967
|
+
};
|
|
3968
|
+
/** @description Authentication required. */
|
|
3969
|
+
401: {
|
|
3970
|
+
headers: {
|
|
3971
|
+
[name: string]: unknown;
|
|
3972
|
+
};
|
|
3973
|
+
content: {
|
|
3974
|
+
"application/json": {
|
|
3975
|
+
error: {
|
|
3976
|
+
/** @enum {string} */
|
|
3977
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
3978
|
+
details: {
|
|
3979
|
+
/** @enum {string} */
|
|
3980
|
+
reason?: "favorite_limit_reached";
|
|
3981
|
+
};
|
|
3982
|
+
message: string;
|
|
3983
|
+
requestId: string;
|
|
3984
|
+
};
|
|
3985
|
+
};
|
|
3986
|
+
};
|
|
3987
|
+
};
|
|
3988
|
+
/** @description Workspace not found, or the item is not one the caller can list. */
|
|
3989
|
+
404: {
|
|
3990
|
+
headers: {
|
|
3991
|
+
[name: string]: unknown;
|
|
3992
|
+
};
|
|
3993
|
+
content: {
|
|
3994
|
+
"application/json": {
|
|
3995
|
+
error: {
|
|
3996
|
+
/** @enum {string} */
|
|
3997
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
3998
|
+
details: {
|
|
3999
|
+
/** @enum {string} */
|
|
4000
|
+
reason?: "favorite_limit_reached";
|
|
4001
|
+
};
|
|
4002
|
+
message: string;
|
|
4003
|
+
requestId: string;
|
|
4004
|
+
};
|
|
4005
|
+
};
|
|
4006
|
+
};
|
|
4007
|
+
};
|
|
4008
|
+
/** @description The captured authority changed; retry. `favorite_limit_reached` means the caller keeps the maximum number of stars. */
|
|
4009
|
+
409: {
|
|
4010
|
+
headers: {
|
|
4011
|
+
[name: string]: unknown;
|
|
4012
|
+
};
|
|
4013
|
+
content: {
|
|
4014
|
+
"application/json": {
|
|
4015
|
+
error: {
|
|
4016
|
+
/** @enum {string} */
|
|
4017
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
4018
|
+
details: {
|
|
4019
|
+
/** @enum {string} */
|
|
4020
|
+
reason?: "favorite_limit_reached";
|
|
4021
|
+
};
|
|
4022
|
+
message: string;
|
|
4023
|
+
requestId: string;
|
|
4024
|
+
};
|
|
4025
|
+
};
|
|
4026
|
+
};
|
|
4027
|
+
};
|
|
4028
|
+
/** @description Invalid request. */
|
|
4029
|
+
422: {
|
|
4030
|
+
headers: {
|
|
4031
|
+
[name: string]: unknown;
|
|
4032
|
+
};
|
|
4033
|
+
content: {
|
|
4034
|
+
"application/json": {
|
|
4035
|
+
error: {
|
|
4036
|
+
/** @enum {string} */
|
|
4037
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
4038
|
+
details: {
|
|
4039
|
+
/** @enum {string} */
|
|
4040
|
+
reason?: "favorite_limit_reached";
|
|
4041
|
+
};
|
|
4042
|
+
message: string;
|
|
4043
|
+
requestId: string;
|
|
4044
|
+
};
|
|
4045
|
+
};
|
|
4046
|
+
};
|
|
4047
|
+
};
|
|
4048
|
+
/** @description Authoritative state is unavailable. */
|
|
4049
|
+
503: {
|
|
4050
|
+
headers: {
|
|
4051
|
+
[name: string]: unknown;
|
|
4052
|
+
};
|
|
4053
|
+
content: {
|
|
4054
|
+
"application/json": {
|
|
4055
|
+
error: {
|
|
4056
|
+
/** @enum {string} */
|
|
4057
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
4058
|
+
details: {
|
|
4059
|
+
/** @enum {string} */
|
|
4060
|
+
reason?: "favorite_limit_reached";
|
|
4061
|
+
};
|
|
4062
|
+
message: string;
|
|
4063
|
+
requestId: string;
|
|
4064
|
+
};
|
|
4065
|
+
};
|
|
4066
|
+
};
|
|
4067
|
+
};
|
|
4068
|
+
};
|
|
4069
|
+
};
|
|
4070
|
+
unstarItem: {
|
|
4071
|
+
parameters: {
|
|
4072
|
+
query?: never;
|
|
4073
|
+
header?: never;
|
|
4074
|
+
path: {
|
|
4075
|
+
workspaceId: string;
|
|
4076
|
+
itemId: string;
|
|
4077
|
+
};
|
|
4078
|
+
cookie?: never;
|
|
4079
|
+
};
|
|
4080
|
+
requestBody?: never;
|
|
4081
|
+
responses: {
|
|
4082
|
+
/** @description The item is not starred. */
|
|
4083
|
+
200: {
|
|
4084
|
+
headers: {
|
|
4085
|
+
[name: string]: unknown;
|
|
4086
|
+
};
|
|
4087
|
+
content: {
|
|
4088
|
+
"application/json": {
|
|
4089
|
+
favorite: boolean;
|
|
4090
|
+
itemId: string;
|
|
4091
|
+
workspaceId: string;
|
|
4092
|
+
};
|
|
4093
|
+
};
|
|
4094
|
+
};
|
|
4095
|
+
/** @description Authentication required. */
|
|
4096
|
+
401: {
|
|
4097
|
+
headers: {
|
|
4098
|
+
[name: string]: unknown;
|
|
4099
|
+
};
|
|
4100
|
+
content: {
|
|
4101
|
+
"application/json": {
|
|
4102
|
+
error: {
|
|
4103
|
+
/** @enum {string} */
|
|
4104
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
4105
|
+
details: {
|
|
4106
|
+
/** @enum {string} */
|
|
4107
|
+
reason?: "favorite_limit_reached";
|
|
4108
|
+
};
|
|
4109
|
+
message: string;
|
|
4110
|
+
requestId: string;
|
|
4111
|
+
};
|
|
4112
|
+
};
|
|
4113
|
+
};
|
|
4114
|
+
};
|
|
4115
|
+
/** @description Workspace not found, or the item is not one the caller can list. */
|
|
4116
|
+
404: {
|
|
4117
|
+
headers: {
|
|
4118
|
+
[name: string]: unknown;
|
|
4119
|
+
};
|
|
4120
|
+
content: {
|
|
4121
|
+
"application/json": {
|
|
4122
|
+
error: {
|
|
4123
|
+
/** @enum {string} */
|
|
4124
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
4125
|
+
details: {
|
|
4126
|
+
/** @enum {string} */
|
|
4127
|
+
reason?: "favorite_limit_reached";
|
|
4128
|
+
};
|
|
4129
|
+
message: string;
|
|
4130
|
+
requestId: string;
|
|
4131
|
+
};
|
|
4132
|
+
};
|
|
4133
|
+
};
|
|
4134
|
+
};
|
|
4135
|
+
/** @description The captured authority changed; retry. `favorite_limit_reached` means the caller keeps the maximum number of stars. */
|
|
4136
|
+
409: {
|
|
4137
|
+
headers: {
|
|
4138
|
+
[name: string]: unknown;
|
|
4139
|
+
};
|
|
4140
|
+
content: {
|
|
4141
|
+
"application/json": {
|
|
4142
|
+
error: {
|
|
4143
|
+
/** @enum {string} */
|
|
4144
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
4145
|
+
details: {
|
|
4146
|
+
/** @enum {string} */
|
|
4147
|
+
reason?: "favorite_limit_reached";
|
|
4148
|
+
};
|
|
4149
|
+
message: string;
|
|
4150
|
+
requestId: string;
|
|
4151
|
+
};
|
|
4152
|
+
};
|
|
4153
|
+
};
|
|
4154
|
+
};
|
|
4155
|
+
/** @description Invalid request. */
|
|
4156
|
+
422: {
|
|
4157
|
+
headers: {
|
|
4158
|
+
[name: string]: unknown;
|
|
4159
|
+
};
|
|
4160
|
+
content: {
|
|
4161
|
+
"application/json": {
|
|
4162
|
+
error: {
|
|
4163
|
+
/** @enum {string} */
|
|
4164
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
4165
|
+
details: {
|
|
4166
|
+
/** @enum {string} */
|
|
4167
|
+
reason?: "favorite_limit_reached";
|
|
4168
|
+
};
|
|
4169
|
+
message: string;
|
|
4170
|
+
requestId: string;
|
|
4171
|
+
};
|
|
4172
|
+
};
|
|
4173
|
+
};
|
|
4174
|
+
};
|
|
4175
|
+
/** @description Authoritative state is unavailable. */
|
|
4176
|
+
503: {
|
|
4177
|
+
headers: {
|
|
4178
|
+
[name: string]: unknown;
|
|
4179
|
+
};
|
|
4180
|
+
content: {
|
|
4181
|
+
"application/json": {
|
|
4182
|
+
error: {
|
|
4183
|
+
/** @enum {string} */
|
|
4184
|
+
code: "authentication_required" | "identity_authority_unavailable" | "resource_not_found" | "invalid_request" | "precondition_failed" | "service_unavailable";
|
|
4185
|
+
details: {
|
|
4186
|
+
/** @enum {string} */
|
|
4187
|
+
reason?: "favorite_limit_reached";
|
|
4188
|
+
};
|
|
4189
|
+
message: string;
|
|
4190
|
+
requestId: string;
|
|
4191
|
+
};
|
|
4192
|
+
};
|
|
4193
|
+
};
|
|
4194
|
+
};
|
|
4195
|
+
};
|
|
4196
|
+
};
|
|
3627
4197
|
transferItemOwnership: {
|
|
3628
4198
|
parameters: {
|
|
3629
4199
|
query?: never;
|
|
@@ -8294,9 +8864,27 @@ interface ListWorkspaceItemsInput extends GetWorkspaceUsageInput {
|
|
|
8294
8864
|
readonly view?: "recent" | "shared" | "trash";
|
|
8295
8865
|
readonly kind?: "file" | "folder";
|
|
8296
8866
|
readonly creatorUserId?: string;
|
|
8867
|
+
/** Present from SDK 0.31. Adds the caller's private `favorite` star to every returned item. */
|
|
8868
|
+
readonly includeFavorite?: boolean;
|
|
8869
|
+
readonly limit?: number;
|
|
8870
|
+
readonly cursor?: string;
|
|
8871
|
+
}
|
|
8872
|
+
/** The caller's private star on one item after a star or unstar request. */
|
|
8873
|
+
type ItemFavorite = Readonly<JsonResponse<"starItem", 200>>;
|
|
8874
|
+
type StarItemInput = ResourceInput;
|
|
8875
|
+
type UnstarItemInput = ResourceInput;
|
|
8876
|
+
interface ListFavoriteItemsInput extends GetWorkspaceUsageInput {
|
|
8297
8877
|
readonly limit?: number;
|
|
8298
8878
|
readonly cursor?: string;
|
|
8299
8879
|
}
|
|
8880
|
+
type GeneratedWorkspaceCounts = JsonResponse<"getWorkspaceCounts", 200>;
|
|
8881
|
+
/** One sidebar count; a value above the server ceiling arrives as the ceiling with `capped: true`. */
|
|
8882
|
+
type WorkspaceCount = Readonly<NonNullable<GeneratedWorkspaceCounts["counts"]["allItems"]>>;
|
|
8883
|
+
/** Sidebar counts for the caller; a count Drive cannot compute exactly and cheaply is omitted. */
|
|
8884
|
+
type WorkspaceCounts = Readonly<Omit<GeneratedWorkspaceCounts, "counts"> & {
|
|
8885
|
+
readonly counts: Readonly<{ [Name in keyof GeneratedWorkspaceCounts["counts"]]?: WorkspaceCount; }>;
|
|
8886
|
+
}>;
|
|
8887
|
+
type WorkspaceCountsInput = GetWorkspaceUsageInput;
|
|
8300
8888
|
type GeneratedOwnedItemPage = JsonResponse<"listOwnedItems", 200>;
|
|
8301
8889
|
/** One item a member effectively owns: an assigned owner, otherwise its recorded creator. */
|
|
8302
8890
|
type OwnedItem = Readonly<Omit<GeneratedOwnedItemPage["items"][number], "currentVersion"> & {
|
|
@@ -8365,9 +8953,12 @@ type CurrentWorkspace = Readonly<Omit<GeneratedCurrentWorkspace, "workspaceRefer
|
|
|
8365
8953
|
}>;
|
|
8366
8954
|
type FolderItem = Readonly<JsonResponse<"createFolder", 201>>;
|
|
8367
8955
|
type GeneratedFolderPage = JsonResponse<"listFolderChildren", 200>;
|
|
8368
|
-
/**
|
|
8956
|
+
/**
|
|
8957
|
+
* `metadata` adds current version size and type, timestamps, creator and effective owner to every listed item;
|
|
8958
|
+
* `favorite` adds the caller's private star. `favorite,metadata` or `metadata,favorite` requests both.
|
|
8959
|
+
*/
|
|
8369
8960
|
type FolderListInclude = NonNullable<FolderChildrenQuery["include"]>;
|
|
8370
|
-
/** A listed child. Detail fields are present exactly when the listing requested `include
|
|
8961
|
+
/** A listed child. Detail fields are present exactly when the listing requested them through `include`. */
|
|
8371
8962
|
type FolderListedItem = Readonly<GeneratedFolderPage["items"][number]>;
|
|
8372
8963
|
type ManagedLifecycleItem = Readonly<JsonResponse<"updateItem", 200>>;
|
|
8373
8964
|
type GeneratedManagedItemMetadata = JsonResponse<"getItem", 200>;
|
|
@@ -8592,6 +9183,14 @@ interface DriveOperations {
|
|
|
8592
9183
|
listIncomingShares(input?: ListIncomingSharesInput): Promise<DriveOperationResult<IncomingSharePage, 200>>;
|
|
8593
9184
|
listIncomingItems(input?: ListIncomingItemsInput): Promise<DriveOperationResult<IncomingItemPage, 200>>;
|
|
8594
9185
|
listWorkspaceItems(input: ListWorkspaceItemsInput): Promise<DriveOperationResult<WorkspaceDiscoveryPage, 200>>;
|
|
9186
|
+
/** Present from SDK 0.31. Stars an item the caller can list; private and idempotent. */
|
|
9187
|
+
starItem(input: StarItemInput): Promise<DriveOperationResult<ItemFavorite, 200>>;
|
|
9188
|
+
/** Present from SDK 0.31. Removes the caller's own star; idempotent. */
|
|
9189
|
+
unstarItem(input: UnstarItemInput): Promise<DriveOperationResult<ItemFavorite, 200>>;
|
|
9190
|
+
/** Present from SDK 0.31. The caller's starred items they can still list, in item order. */
|
|
9191
|
+
listFavoriteItems(input: ListFavoriteItemsInput): Promise<DriveOperationResult<WorkspaceDiscoveryPage, 200>>;
|
|
9192
|
+
/** Present from SDK 0.31. Bounded sidebar counts, each authorized exactly like its listing. */
|
|
9193
|
+
getWorkspaceCounts(input: WorkspaceCountsInput): Promise<DriveOperationResult<WorkspaceCounts, 200>>;
|
|
8595
9194
|
getCurrentUserWorkspaceUsage(input: GetWorkspaceUsageInput): Promise<DriveOperationResult<CurrentUserWorkspaceUsage, 200>>;
|
|
8596
9195
|
getWorkspaceUsage(input: GetWorkspaceUsageInput): Promise<DriveOperationResult<WorkspaceUsage, 200>>;
|
|
8597
9196
|
listOwnedItems(input: ListOwnedItemsInput): Promise<DriveOperationResult<OwnedItemPage, 200>>;
|
|
@@ -8678,4 +9277,4 @@ interface DriveClient extends DriveOperations, VerifiedTransferOperations {
|
|
|
8678
9277
|
uploadVerifiedFile(input: UploadVerifiedFileInput): Promise<DriveOperationResult<PublishedVerifiedTransfer, 200>>;
|
|
8679
9278
|
}
|
|
8680
9279
|
//#endregion
|
|
8681
|
-
export {
|
|
9280
|
+
export { ItemRecipientBatchEntry as $, UploadFileProgressCallback as $t, DriveUploadConfig as A, PreparedVerifiedTransfer as At, FolderListedItem as B, RestoreItemVersionInput as Bt, DriveEditingClientConfig as C, operations as Cn, OwnedItemPage as Ct, DriveResponseValidators as D, PermissionMutation as Dt, DriveOperations as E, PermissionGrantee as Et, EffectivePermissionAction as F, RecoverVerifiedTransferInput as Ft, GetVisitorGrantInput as G, TransferItemOwnershipInput as Gt, GetCurrentWorkspaceInput as H, RevokeVisitorGrantInput as Ht, EffectivePermissionResponse as I, RegisterItemRecipientInput as It, IncomingItemPage as J, UpdateItemInput as Jt, GetWorkspaceUsageInput as K, TrashItemInput as Kt, FileAccessContext as L, RegisterItemRecipientsInput as Lt, DriveVisitorClientConfig as M, PublishVerifiedTransferInput as Mt, EditingSession as N, PublishedVerifiedTransfer as Nt, DriveServerClient as O, PermissionPage as Ot, EditingSessionCreation as P, ReadEffectiveItemPermissionsInput as Pt, ItemOwnershipTransfer as Q, UploadFileProgress as Qt, FolderItem as R, RegisteredRecipientDisplay as Rt, DriveEditingClient as S, WorkspaceUsage as Sn, OwnedItem as St, DriveOperationResult as T, PermissionGrant as Tt, GetItemInput as U, SearchWorkspaceItemsInput as Ut, FolderPage as V, RevokeItemPermissionInput as Vt, GetItemVersionInput as W, StarItemInput as Wt, IncomingSharePage as X, UpdateWorkspaceSharingPolicyInput as Xt, IncomingShareContext as Y, UpdateItemPermissionInput as Yt, ItemFavorite as Z, UploadFilePhase as Zt, DownloadItemResult as _, WorkspaceDiscoveryItem as _n, ManagedItemVersionResource as _t, CollectOwnedItemsInput as a, VisitorChildrenInput as an, ListIncomingItemsInput as at, DriveCredentialContext as b, WorkspaceItemSearchPage as bn, OrganizationMemberStorageUsage as bt, CreateEditingSessionInput as c, VisitorGrant as cn, ListItemSharingPeopleInput as ct, CreateVisitorEditingSessionInput as d, VisitorItem as dn, ListWorkspaceItemsInput as dt, UploadFileStage as en, ItemSharingBatch as et, CreateVisitorGrantInput as f, VisitorReadInput as fn, ManagedDownloadDescriptor as ft, DeleteItemInput as g, WorkspaceCountsInput as gn, ManagedItemVersionPage as gt, CurrentWorkspaceSources as h, WorkspaceCounts as hn, ManagedItemVersion as ht, ChangeEditingSessionInput as i, VisitorChildren as in, ListFolderChildrenInput as it, DriveVisitorClient as j, ProtectionClassification as jt, DriveServerClientConfig as k, PrepareVerifiedTransferInput as kt, CreateFolderInput as l, VisitorGrantCreation as ln, ListItemVersionsInput as lt, CurrentWorkspace as m, WorkspaceCount as mn, ManagedItemMetadata as mt, ArchiveItemInput as n, UploadVerifiedFileInput as nn, ItemSharingPeoplePage as nt, CollectedOwnedItems as o, VisitorDownloadInput as on, ListIncomingSharesInput as ot, CurrentUserWorkspaceUsage as p, VisitorSession as pn, ManagedDownloadRestorePending as pt, IncomingItemMetadata as q, UnstarItemInput as qt, ArchivedItem as r, VerifiedTransferOperations as rn, ListFavoriteItemsInput as rt, CreateDownloadInput as s, VisitorEditingSession as sn, ListItemPermissionsInput as st, AdmittedVerifiedTransfer as t, UploadSmallVerifiedFileInput as tn, ItemSharingBatchResult as tt, CreateItemPermissionInput as u, VisitorGrantPage as un, ListOwnedItemsInput as ut, DriveClient as v, WorkspaceDiscoveryPage as vn, ManagedItemVersionRestoreResult as vt, DriveEditingServerClient as w, PermissionAction as wt, DriveCredentialProvider as x, WorkspaceSharingPolicy as xn, OrganizationMemberStorageUsageInput as xt, DriveClientConfig as y, WorkspaceItemSearchItem as yn, ManagedLifecycleItem as yt, FolderListInclude as z, RestoreItemInput as zt };
|