@maxim_mazurok/gapi.client.admin-datatransfer_v1 0.0.20231127 → 0.0.20231128

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/index.d.ts CHANGED
@@ -9,374 +9,272 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1
12
- // Revision: 20231127
12
+ // Revision: 20231128
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
- /** Load Admin SDK API datatransfer_v1 */
18
- function load(urlOrObject: "https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1"): Promise<void>;
19
- /** @deprecated Please load APIs with discovery documents. */
20
- function load(name: "admin", version: "datatransfer_v1"): Promise<void>;
21
- /** @deprecated Please load APIs with discovery documents. */
22
- function load(name: "admin", version: "datatransfer_v1", callback: () => any): void;
17
+ /** Load Admin SDK API datatransfer_v1 */
18
+ function load(
19
+ urlOrObject: 'https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1'
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'admin', version: 'datatransfer_v1'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(
25
+ name: 'admin',
26
+ version: 'datatransfer_v1',
27
+ callback: () => any
28
+ ): void;
23
29
 
24
- namespace datatransfer {
25
- interface Application {
26
- /** Etag of the resource. */
27
- etag?:
28
- string;
29
- /** The application's ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method. */
30
- id?:
31
- string;
32
- /** Identifies the resource as a DataTransfer Application Resource. */
33
- kind?:
34
- string;
35
- /** The application's name. */
36
- name?:
37
- string;
38
- /** The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer. */
39
- transferParams?:
40
- ApplicationTransferParam[];
41
- }
42
- interface ApplicationDataTransfer {
43
- /** The application's ID. */
44
- applicationId?:
45
- string;
46
- /**
47
- * The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the
48
- * specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
49
- */
50
- applicationTransferParams?:
51
- ApplicationTransferParam[];
52
- /** Read-only. Current status of transfer for this application. */
53
- applicationTransferStatus?:
54
- string;
55
- }
56
- interface ApplicationsListResponse {
57
- /** The list of applications that support data transfer and are also installed for the customer. */
58
- applications?:
59
- Application[];
60
- /** ETag of the resource. */
61
- etag?:
62
- string;
63
- /** Identifies the resource as a collection of Applications. */
64
- kind?:
65
- string;
66
- /** Token to specify the next page in the list. */
67
- nextPageToken?:
68
- string;
69
- }
70
- interface ApplicationTransferParam {
71
- /** The type of the transfer parameter, such as `PRIVACY_LEVEL`. */
72
- key?:
73
- string;
74
- /** The value of the transfer parameter, such as `PRIVATE` or `SHARED`. */
75
- value?:
76
- string[];
77
- }
78
- interface DataTransfer {
79
- /**
80
- * The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which
81
- * data transfer has to be done at the time of the transfer resource creation.
82
- */
83
- applicationDataTransfers?:
84
- ApplicationDataTransfer[];
85
- /** ETag of the resource. */
86
- etag?:
87
- string;
88
- /** Read-only. The transfer's ID. */
89
- id?:
90
- string;
91
- /** Identifies the resource as a DataTransfer request. */
92
- kind?:
93
- string;
94
- /** ID of the user to whom the data is being transferred. */
95
- newOwnerUserId?:
96
- string;
97
- /** ID of the user whose data is being transferred. */
98
- oldOwnerUserId?:
99
- string;
100
- /** Read-only. Overall transfer status. */
101
- overallTransferStatusCode?:
102
- string;
103
- /** Read-only. The time at which the data transfer was requested. */
104
- requestTime?:
105
- string;
106
- }
107
- interface DataTransfersListResponse {
108
- /** List of data transfer requests. */
109
- dataTransfers?:
110
- DataTransfer[];
111
- /** ETag of the resource. */
112
- etag?:
113
- string;
114
- /** Identifies the resource as a collection of data transfer requests. */
115
- kind?:
116
- string;
117
- /** Token to specify the next page in the list. */
118
- nextPageToken?:
119
- string;
120
- }
121
- interface ApplicationsResource {
122
- /** Retrieves information about an application for the given application ID. */
123
- get(request?: {
124
- /** V1 error format. */
125
- "$.xgafv"?:
126
- string;
127
- /** OAuth access token. */
128
- access_token?:
129
- string;
130
- /** Data format for response. */
131
- alt?:
132
- string;
133
- /** ID of the application resource to be retrieved. */
134
- applicationId:
135
- string;
136
- /** JSONP */
137
- callback?:
138
- string;
139
- /** Selector specifying which fields to include in a partial response. */
140
- fields?:
141
- string;
142
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
143
- key?:
144
- string;
145
- /** OAuth 2.0 token for the current user. */
146
- oauth_token?:
147
- string;
148
- /** Returns response with indentations and line breaks. */
149
- prettyPrint?:
150
- boolean;
151
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
152
- quotaUser?:
153
- string;
154
- /** Upload protocol for media (e.g. "raw", "multipart"). */
155
- upload_protocol?:
156
- string;
157
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
158
- uploadType?:
159
- string;
160
- }): Request<Application>;
161
- /** Lists the applications available for data transfer for a customer. */
162
- list(request?: {
163
- /** V1 error format. */
164
- "$.xgafv"?:
165
- string;
166
- /** OAuth access token. */
167
- access_token?:
168
- string;
169
- /** Data format for response. */
170
- alt?:
171
- string;
172
- /** JSONP */
173
- callback?:
174
- string;
175
- /** Immutable ID of the Google Workspace account. */
176
- customerId?:
177
- string;
178
- /** Selector specifying which fields to include in a partial response. */
179
- fields?:
180
- string;
181
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
182
- key?:
183
- string;
184
- /** Maximum number of results to return. Default is 100. */
185
- maxResults?:
186
- number;
187
- /** OAuth 2.0 token for the current user. */
188
- oauth_token?:
189
- string;
190
- /** Token to specify next page in the list. */
191
- pageToken?:
192
- string;
193
- /** Returns response with indentations and line breaks. */
194
- prettyPrint?:
195
- boolean;
196
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
197
- quotaUser?:
198
- string;
199
- /** Upload protocol for media (e.g. "raw", "multipart"). */
200
- upload_protocol?:
201
- string;
202
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
203
- uploadType?:
204
- string;
205
- }): Request<ApplicationsListResponse>;
206
- }
207
- interface TransfersResource {
208
- /** Retrieves a data transfer request by its resource ID. */
209
- get(request?: {
210
- /** V1 error format. */
211
- "$.xgafv"?:
212
- string;
213
- /** OAuth access token. */
214
- access_token?:
215
- string;
216
- /** Data format for response. */
217
- alt?:
218
- string;
219
- /** JSONP */
220
- callback?:
221
- string;
222
- /** ID of the resource to be retrieved. This is returned in the response from the insert method. */
223
- dataTransferId:
224
- string;
225
- /** Selector specifying which fields to include in a partial response. */
226
- fields?:
227
- string;
228
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
229
- key?:
230
- string;
231
- /** OAuth 2.0 token for the current user. */
232
- oauth_token?:
233
- string;
234
- /** Returns response with indentations and line breaks. */
235
- prettyPrint?:
236
- boolean;
237
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
238
- quotaUser?:
239
- string;
240
- /** Upload protocol for media (e.g. "raw", "multipart"). */
241
- upload_protocol?:
242
- string;
243
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
244
- uploadType?:
245
- string;
246
- }): Request<DataTransfer>;
247
- /** Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements. */
248
- insert(request: {
249
- /** V1 error format. */
250
- "$.xgafv"?:
251
- string;
252
- /** OAuth access token. */
253
- access_token?:
254
- string;
255
- /** Data format for response. */
256
- alt?:
257
- string;
258
- /** JSONP */
259
- callback?:
260
- string;
261
- /** Selector specifying which fields to include in a partial response. */
262
- fields?:
263
- string;
264
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
265
- key?:
266
- string;
267
- /** OAuth 2.0 token for the current user. */
268
- oauth_token?:
269
- string;
270
- /** Returns response with indentations and line breaks. */
271
- prettyPrint?:
272
- boolean;
273
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
274
- quotaUser?:
275
- string;
276
- /** Upload protocol for media (e.g. "raw", "multipart"). */
277
- upload_protocol?:
278
- string;
279
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
280
- uploadType?:
281
- string;
282
- /** Request body */
283
- resource:
284
- DataTransfer;
285
- }): Request<DataTransfer>;
286
- insert(request: {
287
- /** V1 error format. */
288
- "$.xgafv"?:
289
- string;
290
- /** OAuth access token. */
291
- access_token?:
292
- string;
293
- /** Data format for response. */
294
- alt?:
295
- string;
296
- /** JSONP */
297
- callback?:
298
- string;
299
- /** Selector specifying which fields to include in a partial response. */
300
- fields?:
301
- string;
302
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
303
- key?:
304
- string;
305
- /** OAuth 2.0 token for the current user. */
306
- oauth_token?:
307
- string;
308
- /** Returns response with indentations and line breaks. */
309
- prettyPrint?:
310
- boolean;
311
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
312
- quotaUser?:
313
- string;
314
- /** Upload protocol for media (e.g. "raw", "multipart"). */
315
- upload_protocol?:
316
- string;
317
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
318
- uploadType?:
319
- string;
320
- },
321
- body: DataTransfer): Request<DataTransfer>;
322
- /** Lists the transfers for a customer by source user, destination user, or status. */
323
- list(request?: {
324
- /** V1 error format. */
325
- "$.xgafv"?:
326
- string;
327
- /** OAuth access token. */
328
- access_token?:
329
- string;
330
- /** Data format for response. */
331
- alt?:
332
- string;
333
- /** JSONP */
334
- callback?:
335
- string;
336
- /** Immutable ID of the Google Workspace account. */
337
- customerId?:
338
- string;
339
- /** Selector specifying which fields to include in a partial response. */
340
- fields?:
341
- string;
342
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
343
- key?:
344
- string;
345
- /** Maximum number of results to return. Default is 100. */
346
- maxResults?:
347
- number;
348
- /** Destination user's profile ID. */
349
- newOwnerUserId?:
350
- string;
351
- /** OAuth 2.0 token for the current user. */
352
- oauth_token?:
353
- string;
354
- /** Source user's profile ID. */
355
- oldOwnerUserId?:
356
- string;
357
- /** Token to specify the next page in the list. */
358
- pageToken?:
359
- string;
360
- /** Returns response with indentations and line breaks. */
361
- prettyPrint?:
362
- boolean;
363
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
364
- quotaUser?:
365
- string;
366
- /** Status of the transfer. */
367
- status?:
368
- string;
369
- /** Upload protocol for media (e.g. "raw", "multipart"). */
370
- upload_protocol?:
371
- string;
372
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
373
- uploadType?:
374
- string;
375
- }): Request<DataTransfersListResponse>;
376
- }
30
+ namespace datatransfer {
31
+ interface Application {
32
+ /** Etag of the resource. */
33
+ etag?: string;
34
+ /** The application's ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method. */
35
+ id?: string;
36
+ /** Identifies the resource as a DataTransfer Application Resource. */
37
+ kind?: string;
38
+ /** The application's name. */
39
+ name?: string;
40
+ /** The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer. */
41
+ transferParams?: ApplicationTransferParam[];
42
+ }
43
+ interface ApplicationDataTransfer {
44
+ /** The application's ID. */
45
+ applicationId?: string;
46
+ /** The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference. */
47
+ applicationTransferParams?: ApplicationTransferParam[];
48
+ /** Read-only. Current status of transfer for this application. */
49
+ applicationTransferStatus?: string;
50
+ }
51
+ interface ApplicationsListResponse {
52
+ /** The list of applications that support data transfer and are also installed for the customer. */
53
+ applications?: Application[];
54
+ /** ETag of the resource. */
55
+ etag?: string;
56
+ /** Identifies the resource as a collection of Applications. */
57
+ kind?: string;
58
+ /** Token to specify the next page in the list. */
59
+ nextPageToken?: string;
60
+ }
61
+ interface ApplicationTransferParam {
62
+ /** The type of the transfer parameter, such as `PRIVACY_LEVEL`. */
63
+ key?: string;
64
+ /** The value of the transfer parameter, such as `PRIVATE` or `SHARED`. */
65
+ value?: string[];
66
+ }
67
+ interface DataTransfer {
68
+ /** The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation. */
69
+ applicationDataTransfers?: ApplicationDataTransfer[];
70
+ /** ETag of the resource. */
71
+ etag?: string;
72
+ /** Read-only. The transfer's ID. */
73
+ id?: string;
74
+ /** Identifies the resource as a DataTransfer request. */
75
+ kind?: string;
76
+ /** ID of the user to whom the data is being transferred. */
77
+ newOwnerUserId?: string;
78
+ /** ID of the user whose data is being transferred. */
79
+ oldOwnerUserId?: string;
80
+ /** Read-only. Overall transfer status. */
81
+ overallTransferStatusCode?: string;
82
+ /** Read-only. The time at which the data transfer was requested. */
83
+ requestTime?: string;
84
+ }
85
+ interface DataTransfersListResponse {
86
+ /** List of data transfer requests. */
87
+ dataTransfers?: DataTransfer[];
88
+ /** ETag of the resource. */
89
+ etag?: string;
90
+ /** Identifies the resource as a collection of data transfer requests. */
91
+ kind?: string;
92
+ /** Token to specify the next page in the list. */
93
+ nextPageToken?: string;
94
+ }
95
+ interface ApplicationsResource {
96
+ /** Retrieves information about an application for the given application ID. */
97
+ get(request?: {
98
+ /** V1 error format. */
99
+ '$.xgafv'?: string;
100
+ /** OAuth access token. */
101
+ access_token?: string;
102
+ /** Data format for response. */
103
+ alt?: string;
104
+ /** ID of the application resource to be retrieved. */
105
+ applicationId: string;
106
+ /** JSONP */
107
+ callback?: string;
108
+ /** Selector specifying which fields to include in a partial response. */
109
+ fields?: string;
110
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
111
+ key?: string;
112
+ /** OAuth 2.0 token for the current user. */
113
+ oauth_token?: string;
114
+ /** Returns response with indentations and line breaks. */
115
+ prettyPrint?: boolean;
116
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
117
+ quotaUser?: string;
118
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
119
+ upload_protocol?: string;
120
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
121
+ uploadType?: string;
122
+ }): Request<Application>;
123
+ /** Lists the applications available for data transfer for a customer. */
124
+ list(request?: {
125
+ /** V1 error format. */
126
+ '$.xgafv'?: string;
127
+ /** OAuth access token. */
128
+ access_token?: string;
129
+ /** Data format for response. */
130
+ alt?: string;
131
+ /** JSONP */
132
+ callback?: string;
133
+ /** Immutable ID of the Google Workspace account. */
134
+ customerId?: string;
135
+ /** Selector specifying which fields to include in a partial response. */
136
+ fields?: string;
137
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
138
+ key?: string;
139
+ /** Maximum number of results to return. Default is 100. */
140
+ maxResults?: number;
141
+ /** OAuth 2.0 token for the current user. */
142
+ oauth_token?: string;
143
+ /** Token to specify next page in the list. */
144
+ pageToken?: string;
145
+ /** Returns response with indentations and line breaks. */
146
+ prettyPrint?: boolean;
147
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
148
+ quotaUser?: string;
149
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
150
+ upload_protocol?: string;
151
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
152
+ uploadType?: string;
153
+ }): Request<ApplicationsListResponse>;
154
+ }
155
+ interface TransfersResource {
156
+ /** Retrieves a data transfer request by its resource ID. */
157
+ get(request?: {
158
+ /** V1 error format. */
159
+ '$.xgafv'?: string;
160
+ /** OAuth access token. */
161
+ access_token?: string;
162
+ /** Data format for response. */
163
+ alt?: string;
164
+ /** JSONP */
165
+ callback?: string;
166
+ /** ID of the resource to be retrieved. This is returned in the response from the insert method. */
167
+ dataTransferId: string;
168
+ /** Selector specifying which fields to include in a partial response. */
169
+ fields?: string;
170
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
171
+ key?: string;
172
+ /** OAuth 2.0 token for the current user. */
173
+ oauth_token?: string;
174
+ /** Returns response with indentations and line breaks. */
175
+ prettyPrint?: boolean;
176
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
177
+ quotaUser?: string;
178
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
179
+ upload_protocol?: string;
180
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
181
+ uploadType?: string;
182
+ }): Request<DataTransfer>;
183
+ /** Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements. */
184
+ insert(request: {
185
+ /** V1 error format. */
186
+ '$.xgafv'?: string;
187
+ /** OAuth access token. */
188
+ access_token?: string;
189
+ /** Data format for response. */
190
+ alt?: string;
191
+ /** JSONP */
192
+ callback?: string;
193
+ /** Selector specifying which fields to include in a partial response. */
194
+ fields?: string;
195
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
196
+ key?: string;
197
+ /** OAuth 2.0 token for the current user. */
198
+ oauth_token?: string;
199
+ /** Returns response with indentations and line breaks. */
200
+ prettyPrint?: boolean;
201
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
202
+ quotaUser?: string;
203
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
204
+ upload_protocol?: string;
205
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
206
+ uploadType?: string;
207
+ /** Request body */
208
+ resource: DataTransfer;
209
+ }): Request<DataTransfer>;
210
+ insert(
211
+ request: {
212
+ /** V1 error format. */
213
+ '$.xgafv'?: string;
214
+ /** OAuth access token. */
215
+ access_token?: string;
216
+ /** Data format for response. */
217
+ alt?: string;
218
+ /** JSONP */
219
+ callback?: string;
220
+ /** Selector specifying which fields to include in a partial response. */
221
+ fields?: string;
222
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
223
+ key?: string;
224
+ /** OAuth 2.0 token for the current user. */
225
+ oauth_token?: string;
226
+ /** Returns response with indentations and line breaks. */
227
+ prettyPrint?: boolean;
228
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
229
+ quotaUser?: string;
230
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
231
+ upload_protocol?: string;
232
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
233
+ uploadType?: string;
234
+ },
235
+ body: DataTransfer
236
+ ): Request<DataTransfer>;
237
+ /** Lists the transfers for a customer by source user, destination user, or status. */
238
+ list(request?: {
239
+ /** V1 error format. */
240
+ '$.xgafv'?: string;
241
+ /** OAuth access token. */
242
+ access_token?: string;
243
+ /** Data format for response. */
244
+ alt?: string;
245
+ /** JSONP */
246
+ callback?: string;
247
+ /** Immutable ID of the Google Workspace account. */
248
+ customerId?: string;
249
+ /** Selector specifying which fields to include in a partial response. */
250
+ fields?: string;
251
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
252
+ key?: string;
253
+ /** Maximum number of results to return. Default is 100. */
254
+ maxResults?: number;
255
+ /** Destination user's profile ID. */
256
+ newOwnerUserId?: string;
257
+ /** OAuth 2.0 token for the current user. */
258
+ oauth_token?: string;
259
+ /** Source user's profile ID. */
260
+ oldOwnerUserId?: string;
261
+ /** Token to specify the next page in the list. */
262
+ pageToken?: string;
263
+ /** Returns response with indentations and line breaks. */
264
+ prettyPrint?: boolean;
265
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
266
+ quotaUser?: string;
267
+ /** Status of the transfer. */
268
+ status?: string;
269
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
270
+ upload_protocol?: string;
271
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
272
+ uploadType?: string;
273
+ }): Request<DataTransfersListResponse>;
274
+ }
377
275
 
378
- const applications: ApplicationsResource;
276
+ const applications: ApplicationsResource;
379
277
 
380
- const transfers: TransfersResource;
381
- }
278
+ const transfers: TransfersResource;
279
+ }
382
280
  }
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.admin-datatransfer_v1",
3
- "version": "0.0.20231127",
3
+ "version": "0.0.20231128",
4
4
  "description": "TypeScript typings for Admin SDK API datatransfer_v1",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
8
+ },
5
9
  "license": "MIT",
6
10
  "author": {
7
- "email": "maxim@mazurok.com",
8
11
  "name": "Maxim Mazurok",
12
+ "email": "maxim@mazurok.com",
9
13
  "url": "https://maxim.mazurok.com"
10
14
  },
11
- "repository": {
12
- "type": "git",
13
- "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
14
- },
15
15
  "types": "index.d.ts",
16
16
  "dependencies": {
17
17
  "@types/gapi.client": "*",
package/readme.md CHANGED
@@ -25,10 +25,13 @@ gapi.load('client', () => {
25
25
  Then load api client wrapper:
26
26
 
27
27
  ```typescript
28
- gapi.client.load('https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1', () => {
29
- // now we can use:
30
- // gapi.client.datatransfer
31
- });
28
+ gapi.client.load(
29
+ 'https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1',
30
+ () => {
31
+ // now we can use:
32
+ // gapi.client.datatransfer
33
+ }
34
+ );
32
35
  ```
33
36
 
34
37
  ```typescript
@@ -45,52 +48,56 @@ Don't forget to authenticate your client before sending any request to resources
45
48
  // declare client_id registered in Google Developers Console
46
49
  var client_id = '',
47
50
  scope = [
48
- // View and manage data transfers between users in your organization
49
- 'https://www.googleapis.com/auth/admin.datatransfer',
51
+ // View and manage data transfers between users in your organization
52
+ 'https://www.googleapis.com/auth/admin.datatransfer',
50
53
 
51
- // View data transfers between users in your organization
52
- 'https://www.googleapis.com/auth/admin.datatransfer.readonly',
53
- ],
54
- immediate = true;
54
+ // View data transfers between users in your organization
55
+ 'https://www.googleapis.com/auth/admin.datatransfer.readonly',
56
+ ],
57
+ immediate = true;
55
58
  // ...
56
59
 
57
60
  gapi.auth.authorize(
58
- { client_id: client_id, scope: scope, immediate: immediate },
61
+ {client_id: client_id, scope: scope, immediate: immediate},
59
62
  authResult => {
60
63
  if (authResult && !authResult.error) {
61
- /* handle successful authorization */
64
+ /* handle successful authorization */
62
65
  } else {
63
- /* handle authorization error */
66
+ /* handle authorization error */
64
67
  }
65
- });
68
+ }
69
+ );
66
70
  ```
67
71
 
68
72
  After that you can use Admin SDK API resources: <!-- TODO: make this work for multiple namespaces -->
69
73
 
70
74
  ```typescript
71
-
72
75
  /*
73
76
  Retrieves information about an application for the given application ID.
74
77
  */
75
- await gapi.client.datatransfer.applications.get({ applicationId: "applicationId", });
78
+ await gapi.client.datatransfer.applications.get({
79
+ applicationId: 'applicationId',
80
+ });
76
81
 
77
82
  /*
78
83
  Lists the applications available for data transfer for a customer.
79
84
  */
80
- await gapi.client.datatransfer.applications.list({ });
85
+ await gapi.client.datatransfer.applications.list({});
81
86
 
82
87
  /*
83
88
  Retrieves a data transfer request by its resource ID.
84
89
  */
85
- await gapi.client.datatransfer.transfers.get({ dataTransferId: "dataTransferId", });
90
+ await gapi.client.datatransfer.transfers.get({
91
+ dataTransferId: 'dataTransferId',
92
+ });
86
93
 
87
94
  /*
88
95
  Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.
89
96
  */
90
- await gapi.client.datatransfer.transfers.insert({ });
97
+ await gapi.client.datatransfer.transfers.insert({});
91
98
 
92
99
  /*
93
100
  Lists the transfers for a customer by source user, destination user, or status.
94
101
  */
95
- await gapi.client.datatransfer.transfers.list({ });
102
+ await gapi.client.datatransfer.transfers.list({});
96
103
  ```
package/tests.ts DELETED
@@ -1,83 +0,0 @@
1
- /* This is stub file for gapi.client.admin-datatransfer_v1 definition tests */
2
- // IMPORTANT
3
- // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
- // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
-
6
- // Revision: 20231127
7
-
8
- gapi.load('client', async () => {
9
- /** now we can use gapi.client */
10
-
11
- await gapi.client.load('https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1');
12
- /** now we can use gapi.client.datatransfer */
13
-
14
- /** don't forget to authenticate your client before sending any request to resources: */
15
- /** declare client_id registered in Google Developers Console */
16
- const client_id = '<<PUT YOUR CLIENT ID HERE>>';
17
- const scope = [
18
- /** View and manage data transfers between users in your organization */
19
- 'https://www.googleapis.com/auth/admin.datatransfer',
20
- /** View data transfers between users in your organization */
21
- 'https://www.googleapis.com/auth/admin.datatransfer.readonly',
22
- ];
23
- const immediate = false;
24
- gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
25
- if (authResult && !authResult.error) {
26
- /** handle successful authorization */
27
- run();
28
- } else {
29
- /** handle authorization error */
30
- }
31
- });
32
-
33
- async function run() {
34
- /** Retrieves information about an application for the given application ID. */
35
- await gapi.client.datatransfer.applications.get({
36
- applicationId: "Test string",
37
- });
38
- /** Lists the applications available for data transfer for a customer. */
39
- await gapi.client.datatransfer.applications.list({
40
- customerId: "Test string",
41
- maxResults: 42,
42
- pageToken: "Test string",
43
- });
44
- /** Retrieves a data transfer request by its resource ID. */
45
- await gapi.client.datatransfer.transfers.get({
46
- dataTransferId: "Test string",
47
- });
48
- /** Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements. */
49
- await gapi.client.datatransfer.transfers.insert({
50
- }, {
51
- applicationDataTransfers: [
52
- {
53
- applicationId: "Test string",
54
- applicationTransferParams: [
55
- {
56
- key: "Test string",
57
- value: [
58
- "Test string"
59
- ],
60
- }
61
- ],
62
- applicationTransferStatus: "Test string",
63
- }
64
- ],
65
- etag: "Test string",
66
- id: "Test string",
67
- kind: "Test string",
68
- newOwnerUserId: "Test string",
69
- oldOwnerUserId: "Test string",
70
- overallTransferStatusCode: "Test string",
71
- requestTime: "Test string",
72
- });
73
- /** Lists the transfers for a customer by source user, destination user, or status. */
74
- await gapi.client.datatransfer.transfers.list({
75
- customerId: "Test string",
76
- maxResults: 42,
77
- newOwnerUserId: "Test string",
78
- oldOwnerUserId: "Test string",
79
- pageToken: "Test string",
80
- status: "Test string",
81
- });
82
- }
83
- });
package/tsconfig.json DELETED
@@ -1,18 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "module": "commonjs",
4
- "lib": ["es6", "dom"],
5
- "noImplicitAny": true,
6
- "noImplicitThis": true,
7
- "strictNullChecks": true,
8
- "baseUrl": "../",
9
- "typeRoots": [
10
- "../"
11
- ],
12
- "types": [],
13
- "noEmit": true,
14
- "forceConsistentCasingInFileNames": true,
15
- "strictFunctionTypes": true
16
- },
17
- "files": ["index.d.ts", "tests.ts"]
18
- }
package/tslint.json DELETED
@@ -1,6 +0,0 @@
1
- {
2
- "extends": "dtslint/dtslint.json",
3
- "rules": {
4
- "no-redundant-jsdoc": false
5
- }
6
- }