@maxim_mazurok/gapi.client.admin-datatransfer_v1 0.0.20221018 → 0.0.20221108

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.
Files changed (4) hide show
  1. package/index.d.ts +19 -16
  2. package/package.json +1 -1
  3. package/readme.md +1 -1
  4. package/tests.ts +2 -2
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
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: 20221018
12
+ // Revision: 20221108
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -25,48 +25,51 @@ declare namespace gapi.client {
25
25
  interface Application {
26
26
  /** Etag of the resource. */
27
27
  etag?: string;
28
- /** The application's ID. */
28
+ /** The application's ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method. */
29
29
  id?: string;
30
30
  /** Identifies the resource as a DataTransfer Application Resource. */
31
31
  kind?: string;
32
32
  /** The application's name. */
33
33
  name?: string;
34
- /** The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transferred. */
34
+ /** The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer. */
35
35
  transferParams?: ApplicationTransferParam[];
36
36
  }
37
37
  interface ApplicationDataTransfer {
38
38
  /** The application's ID. */
39
39
  applicationId?: string;
40
- /** The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. */
40
+ /**
41
+ * 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
42
+ * specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
43
+ */
41
44
  applicationTransferParams?: ApplicationTransferParam[];
42
- /** Current status of transfer for this application. (Read-only) */
45
+ /** Read-only. Current status of transfer for this application. */
43
46
  applicationTransferStatus?: string;
44
47
  }
45
48
  interface ApplicationsListResponse {
46
- /** List of applications that support data transfer and are also installed for the customer. */
49
+ /** The list of applications that support data transfer and are also installed for the customer. */
47
50
  applications?: Application[];
48
51
  /** ETag of the resource. */
49
52
  etag?: string;
50
53
  /** Identifies the resource as a collection of Applications. */
51
54
  kind?: string;
52
- /** Continuation token which will be used to specify next page in list API. */
55
+ /** Token to specify the next page in the list. */
53
56
  nextPageToken?: string;
54
57
  }
55
58
  interface ApplicationTransferParam {
56
- /** The type of the transfer parameter. eg: 'PRIVACY_LEVEL' */
59
+ /** The type of the transfer parameter, such as `PRIVACY_LEVEL`. */
57
60
  key?: string;
58
- /** The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED' */
61
+ /** The value of the transfer parameter, such as `PRIVATE` or `SHARED`. */
59
62
  value?: string[];
60
63
  }
61
64
  interface DataTransfer {
62
65
  /**
63
- * List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to
64
- * specify the applications for which data transfer has to be done at the time of the transfer resource creation.
66
+ * 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
67
+ * data transfer has to be done at the time of the transfer resource creation.
65
68
  */
66
69
  applicationDataTransfers?: ApplicationDataTransfer[];
67
70
  /** ETag of the resource. */
68
71
  etag?: string;
69
- /** The transfer's ID (Read-only). */
72
+ /** Read-only. The transfer's ID. */
70
73
  id?: string;
71
74
  /** Identifies the resource as a DataTransfer request. */
72
75
  kind?: string;
@@ -74,9 +77,9 @@ declare namespace gapi.client {
74
77
  newOwnerUserId?: string;
75
78
  /** ID of the user whose data is being transferred. */
76
79
  oldOwnerUserId?: string;
77
- /** Overall transfer status (Read-only). */
80
+ /** Read-only. Overall transfer status. */
78
81
  overallTransferStatusCode?: string;
79
- /** The time at which the data transfer was requested (Read-only). */
82
+ /** Read-only. The time at which the data transfer was requested. */
80
83
  requestTime?: string;
81
84
  }
82
85
  interface DataTransfersListResponse {
@@ -86,7 +89,7 @@ declare namespace gapi.client {
86
89
  etag?: string;
87
90
  /** Identifies the resource as a collection of data transfer requests. */
88
91
  kind?: string;
89
- /** Continuation token which will be used to specify next page in list API. */
92
+ /** Token to specify the next page in the list. */
90
93
  nextPageToken?: string;
91
94
  }
92
95
  interface ApplicationsResource {
@@ -177,7 +180,7 @@ declare namespace gapi.client {
177
180
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
178
181
  uploadType?: string;
179
182
  }): Request<DataTransfer>;
180
- /** Inserts a data transfer request. */
183
+ /** Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements. */
181
184
  insert(request: {
182
185
  /** V1 error format. */
183
186
  "$.xgafv"?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.admin-datatransfer_v1",
3
- "version": "0.0.20221018",
3
+ "version": "0.0.20221108",
4
4
  "description": "TypeScript typings for Admin SDK API datatransfer_v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -85,7 +85,7 @@ Retrieves a data transfer request by its resource ID.
85
85
  await gapi.client.datatransfer.transfers.get({ dataTransferId: "dataTransferId", });
86
86
 
87
87
  /*
88
- Inserts a data transfer request.
88
+ Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.
89
89
  */
90
90
  await gapi.client.datatransfer.transfers.insert({ });
91
91
 
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20221018
6
+ // Revision: 20221108
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -45,7 +45,7 @@ gapi.load('client', async () => {
45
45
  await gapi.client.datatransfer.transfers.get({
46
46
  dataTransferId: "Test string",
47
47
  });
48
- /** Inserts a data transfer request. */
48
+ /** Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements. */
49
49
  await gapi.client.datatransfer.transfers.insert({
50
50
  }, {
51
51
  applicationDataTransfers: [