@maxim_mazurok/gapi.client.tasks-v1 0.2.20261020 → 0.2.20261025

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 (3) hide show
  1. package/index.d.ts +26 -22
  2. package/package.json +1 -1
  3. package/readme.md +1 -1
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://tasks.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20261020
12
+ // Revision: 20261025
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -90,7 +90,7 @@ declare namespace gapi.client {
90
90
  interface TaskList {
91
91
  /** ETag of the resource. */
92
92
  etag?: string;
93
- /** Task list identifier. */
93
+ /** Task list identifier. In requests, the authenticated user's default task list can also be referred to as "@default". */
94
94
  id?: string;
95
95
  /** Output only. Type of the resource. This is always "tasks#taskList". */
96
96
  kind?: string;
@@ -122,7 +122,7 @@ declare namespace gapi.client {
122
122
  nextPageToken?: string;
123
123
  }
124
124
  interface TasklistsResource {
125
- /** Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted. */
125
+ /** Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted. The user's default task list cannot be deleted. */
126
126
  delete(request?: {
127
127
  /** V1 error format. */
128
128
  '$.xgafv'?: '1' | '2';
@@ -142,7 +142,7 @@ declare namespace gapi.client {
142
142
  prettyPrint?: boolean;
143
143
  /** 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. */
144
144
  quotaUser?: string;
145
- /** Task list identifier. */
145
+ /** Task list identifier. The default task list cannot be deleted. */
146
146
  tasklist: string;
147
147
  /** Upload protocol for media (e.g. "raw", "multipart"). */
148
148
  upload_protocol?: string;
@@ -169,7 +169,7 @@ declare namespace gapi.client {
169
169
  prettyPrint?: boolean;
170
170
  /** 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. */
171
171
  quotaUser?: string;
172
- /** Task list identifier. */
172
+ /** Task list identifier. Use "@default" to get the authenticated user's default task list. */
173
173
  tasklist: string;
174
174
  /** Upload protocol for media (e.g. "raw", "multipart"). */
175
175
  upload_protocol?: string;
@@ -244,11 +244,11 @@ declare namespace gapi.client {
244
244
  fields?: string;
245
245
  /** 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. */
246
246
  key?: string;
247
- /** Maximum number of task lists returned on one page. Optional. The default is 1000 (max allowed: 1000). */
247
+ /** Optional. Maximum number of task lists returned on one page. The default is 1000 (max allowed: 1000). */
248
248
  maxResults?: number;
249
249
  /** OAuth 2.0 token for the current user. */
250
250
  oauth_token?: string;
251
- /** Token specifying the result page to return. Optional. */
251
+ /** Optional. Token specifying the result page to return. */
252
252
  pageToken?: string;
253
253
  /** Returns response with indentations and line breaks. */
254
254
  prettyPrint?: boolean;
@@ -474,15 +474,17 @@ declare namespace gapi.client {
474
474
  callback?: string;
475
475
  /** Selector specifying which fields to include in a partial response. */
476
476
  fields?: string;
477
+ /** Optional. Flag indicating whether the task is created as 'hidden', as if it had been completed and then cleared from the task list (see the "clear" method). Hidden tasks are not returned by default when retrieving all tasks for a task list (see showHidden). Only completed tasks can be created as hidden, and they can not be nested or positioned, so parent and previous must be empty. */
478
+ hidden?: boolean;
477
479
  /** 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. */
478
480
  key?: string;
479
481
  /** OAuth 2.0 token for the current user. */
480
482
  oauth_token?: string;
481
- /** Parent task identifier. If the task is created at the top level, this parameter is omitted. An assigned task cannot be a parent task, nor can it have a parent. Setting the parent to an assigned task results in failure of the request. Optional. */
483
+ /** Optional. Parent task identifier. If the task is created at the top level, this parameter is omitted. An assigned task cannot be a parent task, nor can it have a parent. Setting the parent to an assigned task results in failure of the request. */
482
484
  parent?: string;
483
485
  /** Returns response with indentations and line breaks. */
484
486
  prettyPrint?: boolean;
485
- /** Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional. */
487
+ /** Optional. Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. */
486
488
  previous?: string;
487
489
  /** 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. */
488
490
  quotaUser?: string;
@@ -507,15 +509,17 @@ declare namespace gapi.client {
507
509
  callback?: string;
508
510
  /** Selector specifying which fields to include in a partial response. */
509
511
  fields?: string;
512
+ /** Optional. Flag indicating whether the task is created as 'hidden', as if it had been completed and then cleared from the task list (see the "clear" method). Hidden tasks are not returned by default when retrieving all tasks for a task list (see showHidden). Only completed tasks can be created as hidden, and they can not be nested or positioned, so parent and previous must be empty. */
513
+ hidden?: boolean;
510
514
  /** 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. */
511
515
  key?: string;
512
516
  /** OAuth 2.0 token for the current user. */
513
517
  oauth_token?: string;
514
- /** Parent task identifier. If the task is created at the top level, this parameter is omitted. An assigned task cannot be a parent task, nor can it have a parent. Setting the parent to an assigned task results in failure of the request. Optional. */
518
+ /** Optional. Parent task identifier. If the task is created at the top level, this parameter is omitted. An assigned task cannot be a parent task, nor can it have a parent. Setting the parent to an assigned task results in failure of the request. */
515
519
  parent?: string;
516
520
  /** Returns response with indentations and line breaks. */
517
521
  prettyPrint?: boolean;
518
- /** Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional. */
522
+ /** Optional. Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. */
519
523
  previous?: string;
520
524
  /** 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. */
521
525
  quotaUser?: string;
@@ -538,39 +542,39 @@ declare namespace gapi.client {
538
542
  alt?: 'json' | 'media' | 'proto';
539
543
  /** JSONP */
540
544
  callback?: string;
541
- /** Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. */
545
+ /** Optional. Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. The default is not to filter by completion date. */
542
546
  completedMax?: string;
543
- /** Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. */
547
+ /** Optional. Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. The default is not to filter by completion date. */
544
548
  completedMin?: string;
545
- /** Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. */
549
+ /** Optional. Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. The default is not to filter by due date. */
546
550
  dueMax?: string;
547
- /** Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. */
551
+ /** Optional. Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. The default is not to filter by due date. */
548
552
  dueMin?: string;
549
553
  /** Selector specifying which fields to include in a partial response. */
550
554
  fields?: string;
551
555
  /** 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. */
552
556
  key?: string;
553
- /** Maximum number of tasks returned on one page. Optional. The default is 20 (max allowed: 100). */
557
+ /** Optional. Maximum number of tasks returned on one page. The default is 20 (max allowed: 100). */
554
558
  maxResults?: number;
555
559
  /** OAuth 2.0 token for the current user. */
556
560
  oauth_token?: string;
557
- /** Token specifying the result page to return. Optional. */
561
+ /** Optional. Token specifying the result page to return. */
558
562
  pageToken?: string;
559
563
  /** Returns response with indentations and line breaks. */
560
564
  prettyPrint?: boolean;
561
565
  /** 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. */
562
566
  quotaUser?: string;
563
- /** Optional. Flag indicating whether tasks assigned to the current user are returned in the result. Optional. The default is False. */
567
+ /** Optional. Flag indicating whether tasks assigned to the current user are returned in the result. The default is False. */
564
568
  showAssigned?: boolean;
565
- /** Flag indicating whether completed tasks are returned in the result. Note that showHidden must also be True to show tasks completed in first party clients, such as the web UI and Google's mobile apps. Optional. The default is True. */
569
+ /** Optional. Flag indicating whether completed tasks are returned in the result. Note that showHidden must also be True to show tasks completed in first party clients, such as the web UI and Google's mobile apps. The default is True. */
566
570
  showCompleted?: boolean;
567
- /** Flag indicating whether deleted tasks are returned in the result. Optional. The default is False. */
571
+ /** Optional. Flag indicating whether deleted tasks are returned in the result. The default is False. */
568
572
  showDeleted?: boolean;
569
- /** Flag indicating whether hidden tasks are returned in the result. Optional. The default is False. */
573
+ /** Optional. Flag indicating whether hidden tasks are returned in the result. The default is False. */
570
574
  showHidden?: boolean;
571
575
  /** Task list identifier. */
572
576
  tasklist: string;
573
- /** Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time. */
577
+ /** Optional. Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. The default is not to filter by last modification time. */
574
578
  updatedMin?: string;
575
579
  /** Upload protocol for media (e.g. "raw", "multipart"). */
576
580
  upload_protocol?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.tasks-v1",
3
- "version": "0.2.20261020",
3
+ "version": "0.2.20261025",
4
4
  "description": "TypeScript typings for Google Tasks API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -85,7 +85,7 @@ After that you can use Google Tasks API resources: <!-- TODO: make this work for
85
85
 
86
86
  ```typescript
87
87
  /*
88
- Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted.
88
+ Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted. The user's default task list cannot be deleted.
89
89
  */
90
90
  await gapi.client.tasks.tasklists.delete({tasklist: 'tasklist'});
91
91