@maxim_mazurok/gapi.client.drive-v3 0.0.20230212 → 0.0.20230219

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,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://www.googleapis.com/discovery/v1/apis/drive/v3/rest
12
- // Revision: 20230212
12
+ // Revision: 20230219
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -780,44 +780,48 @@ declare namespace gapi.client {
780
780
  deleted?: boolean;
781
781
  /**
782
782
  * The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
783
- * - user - User's full name, as defined for their Google account, such as "Joe Smith."
783
+ * - user - User's full name, as defined for their Google Account, such as "Joe Smith."
784
784
  * - group - Name of the Google Group, such as "The Company Administrators."
785
- * - domain - String domain name, such as "thecompany.com."
785
+ * - domain - String domain name, such as "your-company.com."
786
786
  * - anyone - No displayName is present.
787
787
  */
788
788
  displayName?: string;
789
- /** The domain to which this permission refers. */
789
+ /**
790
+ * The domain to which this permission refers. The following options are currently allowed:
791
+ * - The entire domain, such as "your-company.com."
792
+ * - A target audience, such as "ID.audience.googledomains.com."
793
+ */
790
794
  domain?: string;
791
795
  /** The email address of the user or group to which this permission refers. */
792
796
  emailAddress?: string;
793
797
  /**
794
798
  * The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
795
- * - They cannot be set on shared drive items
796
- * - They can only be set on user and group permissions
797
- * - The time must be in the future
798
- * - The time cannot be more than a year in the future
799
+ * - They cannot be set on shared drive items.
800
+ * - They can only be set on user and group permissions.
801
+ * - The time must be in the future.
802
+ * - The time cannot be more than one year in the future.
799
803
  */
800
804
  expirationTime?: string;
801
805
  /** The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values. */
802
806
  id?: string;
803
807
  /** Identifies what kind of resource this is. Value: the fixed string "drive#permission". */
804
808
  kind?: string;
805
- /** Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. */
809
+ /** Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive. */
806
810
  pendingOwner?: boolean;
807
- /** Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. */
811
+ /** Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items. */
808
812
  permissionDetails?: Array<{
809
813
  /** Whether this permission is inherited. This field is always populated. This is an output-only field. */
810
814
  inherited?: boolean;
811
815
  /** The ID of the item from which this permission is inherited. This is an output-only field. */
812
816
  inheritedFrom?: string;
813
817
  /**
814
- * The permission type for this user. While new values may be added in future, the following are currently possible:
818
+ * The permission type for this user. While new values may be added in future, the following are currently allowed:
815
819
  * - file
816
820
  * - member
817
821
  */
818
822
  permissionType?: string;
819
823
  /**
820
- * The primary role for this user. While new values may be added in the future, the following are currently possible:
824
+ * The primary role for this user. While new values may be added in the future, the following are currently allowed:
821
825
  * - organizer
822
826
  * - fileOrganizer
823
827
  * - writer
@@ -855,7 +859,7 @@ declare namespace gapi.client {
855
859
  * - group
856
860
  * - domain
857
861
  * - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't
858
- * extra information required for a anyone type.
862
+ * extra information required for the anyone type.
859
863
  */
860
864
  type?: string;
861
865
  /** Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. */
@@ -1191,7 +1195,7 @@ declare namespace gapi.client {
1191
1195
  /** Deprecated. Please use quotaUser instead. */
1192
1196
  userIp?: string;
1193
1197
  }): Request<ChangeList>;
1194
- /** Subscribes to changes for a user. */
1198
+ /** Subscribes to changes for a user. To use this method, you must include the pageToken query parameter. */
1195
1199
  watch(request: {
1196
1200
  /** Data format for the response. */
1197
1201
  alt?: string;
@@ -2267,7 +2271,7 @@ declare namespace gapi.client {
2267
2271
  body: Channel): Request<Channel>;
2268
2272
  }
2269
2273
  interface PermissionsResource {
2270
- /** Creates a permission for a file or shared drive. */
2274
+ /** Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives. */
2271
2275
  create(request: {
2272
2276
  /** Data format for the response. */
2273
2277
  alt?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.drive-v3",
3
- "version": "0.0.20230212",
3
+ "version": "0.0.20230219",
4
4
  "description": "TypeScript typings for Drive API v3",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -103,7 +103,7 @@ Lists the changes for a user or shared drive.
103
103
  await gapi.client.drive.changes.list({ pageToken: "pageToken", });
104
104
 
105
105
  /*
106
- Subscribes to changes for a user.
106
+ Subscribes to changes for a user. To use this method, you must include the pageToken query parameter.
107
107
  */
108
108
  await gapi.client.drive.changes.watch({ pageToken: "pageToken", });
109
109
 
@@ -233,7 +233,7 @@ Subscribes to changes to a file. While you can establish a channel for changes t
233
233
  await gapi.client.drive.files.watch({ fileId: "fileId", });
234
234
 
235
235
  /*
236
- Creates a permission for a file or shared drive.
236
+ Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives.
237
237
  */
238
238
  await gapi.client.drive.permissions.create({ fileId: "fileId", });
239
239
 
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: 20230212
6
+ // Revision: 20230219
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -69,7 +69,7 @@ gapi.load('client', async () => {
69
69
  supportsTeamDrives: true,
70
70
  teamDriveId: "Test string",
71
71
  });
72
- /** Subscribes to changes for a user. */
72
+ /** Subscribes to changes for a user. To use this method, you must include the pageToken query parameter. */
73
73
  await gapi.client.drive.changes.watch({
74
74
  driveId: "Test string",
75
75
  includeCorpusRemovals: true,
@@ -1320,7 +1320,7 @@ gapi.load('client', async () => {
1320
1320
  token: "Test string",
1321
1321
  type: "Test string",
1322
1322
  });
1323
- /** Creates a permission for a file or shared drive. */
1323
+ /** Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives. */
1324
1324
  await gapi.client.drive.permissions.create({
1325
1325
  emailMessage: "Test string",
1326
1326
  enforceSingleParent: true,