@maxim_mazurok/gapi.client.forms-v1 0.1.20260311 → 0.2.20260311

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 (2) hide show
  1. package/index.d.ts +61 -39
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -56,7 +56,7 @@ declare namespace gapi.client {
56
56
  /** Whether the options should be displayed in random order for different instances of the quiz. This is often used to prevent cheating by respondents who might be looking at another respondent's screen, or to address bias in a survey that might be introduced by always putting the same options first or last. */
57
57
  shuffle?: boolean;
58
58
  /** Required. The type of choice question. */
59
- type?: string;
59
+ type?: 'CHOICE_TYPE_UNSPECIFIED' | 'RADIO' | 'CHECKBOX' | 'DROP_DOWN';
60
60
  }
61
61
  interface CloudPubsubTopic {
62
62
  /** Required. A fully qualified Pub/Sub topic name to publish the events to. This topic must be owned by the calling project and already exist in Pub/Sub. */
@@ -131,7 +131,17 @@ declare namespace gapi.client {
131
131
  /** Maximum number of bytes allowed for any single file uploaded to this question. */
132
132
  maxFileSize?: string;
133
133
  /** File types accepted by this question. */
134
- types?: string[];
134
+ types?:
135
+ | 'FILE_TYPE_UNSPECIFIED'
136
+ | 'ANY'
137
+ | 'DOCUMENT'
138
+ | 'PRESENTATION'
139
+ | 'SPREADSHEET'
140
+ | 'DRAWING'
141
+ | 'PDF'
142
+ | 'IMAGE'
143
+ | 'VIDEO'
144
+ | 'AUDIO'[];
135
145
  }
136
146
  interface Form {
137
147
  /** Output only. The form ID. */
@@ -169,7 +179,11 @@ declare namespace gapi.client {
169
179
  }
170
180
  interface FormSettings {
171
181
  /** Optional. The setting that determines whether the form collects email addresses from respondents. */
172
- emailCollectionType?: string;
182
+ emailCollectionType?:
183
+ | 'EMAIL_COLLECTION_TYPE_UNSPECIFIED'
184
+ | 'DO_NOT_COLLECT'
185
+ | 'VERIFIED'
186
+ | 'RESPONDER_INPUT';
173
187
  /** Settings related to quiz forms and grading. */
174
188
  quizSettings?: QuizSettings;
175
189
  }
@@ -257,7 +271,7 @@ declare namespace gapi.client {
257
271
  }
258
272
  interface MediaProperties {
259
273
  /** Position of the media. */
260
- alignment?: string;
274
+ alignment?: 'ALIGNMENT_UNSPECIFIED' | 'LEFT' | 'RIGHT' | 'CENTER';
261
275
  /** The width of the media in pixels. When the media is displayed, it is scaled to the smaller of this value or the width of the displayed form. The original aspect ratio of the media is preserved. If a width is not specified when the media is added to the form, it is set to the width of the media source. Width must be between 0 and 740, inclusive. Setting width to 0 or unspecified is only permitted when updating the media source. */
262
276
  width?: number;
263
277
  }
@@ -269,7 +283,11 @@ declare namespace gapi.client {
269
283
  }
270
284
  interface Option {
271
285
  /** Section navigation type. */
272
- goToAction?: string;
286
+ goToAction?:
287
+ | 'GO_TO_ACTION_UNSPECIFIED'
288
+ | 'NEXT_SECTION'
289
+ | 'RESTART_FORM'
290
+ | 'SUBMIT_FORM';
273
291
  /** Item ID of section header to go to. */
274
292
  goToSectionId?: string;
275
293
  /** Display image as an option. */
@@ -334,7 +352,7 @@ declare namespace gapi.client {
334
352
  }
335
353
  interface RatingQuestion {
336
354
  /** Required. The icon type to use for the rating. */
337
- iconType?: string;
355
+ iconType?: 'RATING_ICON_TYPE_UNSPECIFIED' | 'STAR' | 'HEART' | 'THUMB_UP';
338
356
  /** Required. The rating scale level of the rating question. */
339
357
  ratingScaleLevel?: number;
340
358
  }
@@ -448,15 +466,19 @@ declare namespace gapi.client {
448
466
  /** Output only. Timestamp of when this was created. */
449
467
  createTime?: string;
450
468
  /** Output only. The most recent error type for an attempted delivery. To begin watching the form again a call can be made to watches.renew which also clears this error information. */
451
- errorType?: string;
469
+ errorType?:
470
+ | 'ERROR_TYPE_UNSPECIFIED'
471
+ | 'PROJECT_NOT_AUTHORIZED'
472
+ | 'NO_USER_ACCESS'
473
+ | 'OTHER_ERRORS';
452
474
  /** Required. Which event type to watch for. */
453
- eventType?: string;
475
+ eventType?: 'EVENT_TYPE_UNSPECIFIED' | 'SCHEMA' | 'RESPONSES';
454
476
  /** Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future. */
455
477
  expireTime?: string;
456
478
  /** Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id. */
457
479
  id?: string;
458
480
  /** Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`. */
459
- state?: string;
481
+ state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'SUSPENDED';
460
482
  /** Required. Where to send the notification. */
461
483
  target?: WatchTarget;
462
484
  }
@@ -474,11 +496,11 @@ declare namespace gapi.client {
474
496
  /** Get one response from the form. */
475
497
  get(request?: {
476
498
  /** V1 error format. */
477
- '$.xgafv'?: string;
499
+ '$.xgafv'?: '1' | '2';
478
500
  /** OAuth access token. */
479
501
  access_token?: string;
480
502
  /** Data format for response. */
481
- alt?: string;
503
+ alt?: 'json' | 'media' | 'proto';
482
504
  /** JSONP */
483
505
  callback?: string;
484
506
  /** Selector specifying which fields to include in a partial response. */
@@ -503,11 +525,11 @@ declare namespace gapi.client {
503
525
  /** List a form's responses. */
504
526
  list(request?: {
505
527
  /** V1 error format. */
506
- '$.xgafv'?: string;
528
+ '$.xgafv'?: '1' | '2';
507
529
  /** OAuth access token. */
508
530
  access_token?: string;
509
531
  /** Data format for response. */
510
- alt?: string;
532
+ alt?: 'json' | 'media' | 'proto';
511
533
  /** JSONP */
512
534
  callback?: string;
513
535
  /** Selector specifying which fields to include in a partial response. */
@@ -538,11 +560,11 @@ declare namespace gapi.client {
538
560
  /** Create a new watch. If a watch ID is provided, it must be unused. For each invoking project, the per form limit is one watch per Watch.EventType. A watch expires seven days after it is created (see Watch.expire_time). */
539
561
  create(request: {
540
562
  /** V1 error format. */
541
- '$.xgafv'?: string;
563
+ '$.xgafv'?: '1' | '2';
542
564
  /** OAuth access token. */
543
565
  access_token?: string;
544
566
  /** Data format for response. */
545
- alt?: string;
567
+ alt?: 'json' | 'media' | 'proto';
546
568
  /** JSONP */
547
569
  callback?: string;
548
570
  /** Selector specifying which fields to include in a partial response. */
@@ -567,11 +589,11 @@ declare namespace gapi.client {
567
589
  create(
568
590
  request: {
569
591
  /** V1 error format. */
570
- '$.xgafv'?: string;
592
+ '$.xgafv'?: '1' | '2';
571
593
  /** OAuth access token. */
572
594
  access_token?: string;
573
595
  /** Data format for response. */
574
- alt?: string;
596
+ alt?: 'json' | 'media' | 'proto';
575
597
  /** JSONP */
576
598
  callback?: string;
577
599
  /** Selector specifying which fields to include in a partial response. */
@@ -596,11 +618,11 @@ declare namespace gapi.client {
596
618
  /** Delete a watch. */
597
619
  delete(request?: {
598
620
  /** V1 error format. */
599
- '$.xgafv'?: string;
621
+ '$.xgafv'?: '1' | '2';
600
622
  /** OAuth access token. */
601
623
  access_token?: string;
602
624
  /** Data format for response. */
603
- alt?: string;
625
+ alt?: 'json' | 'media' | 'proto';
604
626
  /** JSONP */
605
627
  callback?: string;
606
628
  /** Selector specifying which fields to include in a partial response. */
@@ -625,11 +647,11 @@ declare namespace gapi.client {
625
647
  /** Return a list of the watches owned by the invoking project. The maximum number of watches is two: For each invoker, the limit is one for each event type per form. */
626
648
  list(request?: {
627
649
  /** V1 error format. */
628
- '$.xgafv'?: string;
650
+ '$.xgafv'?: '1' | '2';
629
651
  /** OAuth access token. */
630
652
  access_token?: string;
631
653
  /** Data format for response. */
632
- alt?: string;
654
+ alt?: 'json' | 'media' | 'proto';
633
655
  /** JSONP */
634
656
  callback?: string;
635
657
  /** Selector specifying which fields to include in a partial response. */
@@ -652,11 +674,11 @@ declare namespace gapi.client {
652
674
  /** Renew an existing watch for seven days. The state of the watch after renewal is `ACTIVE`, and the `expire_time` is seven days from the renewal. Renewing a watch in an error state (e.g. `SUSPENDED`) succeeds if the error is no longer present, but fail otherwise. After a watch has expired, RenewWatch returns `NOT_FOUND`. */
653
675
  renew(request: {
654
676
  /** V1 error format. */
655
- '$.xgafv'?: string;
677
+ '$.xgafv'?: '1' | '2';
656
678
  /** OAuth access token. */
657
679
  access_token?: string;
658
680
  /** Data format for response. */
659
- alt?: string;
681
+ alt?: 'json' | 'media' | 'proto';
660
682
  /** JSONP */
661
683
  callback?: string;
662
684
  /** Selector specifying which fields to include in a partial response. */
@@ -683,11 +705,11 @@ declare namespace gapi.client {
683
705
  renew(
684
706
  request: {
685
707
  /** V1 error format. */
686
- '$.xgafv'?: string;
708
+ '$.xgafv'?: '1' | '2';
687
709
  /** OAuth access token. */
688
710
  access_token?: string;
689
711
  /** Data format for response. */
690
- alt?: string;
712
+ alt?: 'json' | 'media' | 'proto';
691
713
  /** JSONP */
692
714
  callback?: string;
693
715
  /** Selector specifying which fields to include in a partial response. */
@@ -716,11 +738,11 @@ declare namespace gapi.client {
716
738
  /** Change the form with a batch of updates. */
717
739
  batchUpdate(request: {
718
740
  /** V1 error format. */
719
- '$.xgafv'?: string;
741
+ '$.xgafv'?: '1' | '2';
720
742
  /** OAuth access token. */
721
743
  access_token?: string;
722
744
  /** Data format for response. */
723
- alt?: string;
745
+ alt?: 'json' | 'media' | 'proto';
724
746
  /** JSONP */
725
747
  callback?: string;
726
748
  /** Selector specifying which fields to include in a partial response. */
@@ -745,11 +767,11 @@ declare namespace gapi.client {
745
767
  batchUpdate(
746
768
  request: {
747
769
  /** V1 error format. */
748
- '$.xgafv'?: string;
770
+ '$.xgafv'?: '1' | '2';
749
771
  /** OAuth access token. */
750
772
  access_token?: string;
751
773
  /** Data format for response. */
752
- alt?: string;
774
+ alt?: 'json' | 'media' | 'proto';
753
775
  /** JSONP */
754
776
  callback?: string;
755
777
  /** Selector specifying which fields to include in a partial response. */
@@ -774,11 +796,11 @@ declare namespace gapi.client {
774
796
  /** Create a new form using the title given in the provided form message in the request. *Important:* Only the form.info.title and form.info.document_title fields are copied to the new form. All other fields including the form description, items and settings are disallowed. To create a new form and add items, you must first call forms.create to create an empty form with a title and (optional) document title, and then call forms.update to add the items. */
775
797
  create(request: {
776
798
  /** V1 error format. */
777
- '$.xgafv'?: string;
799
+ '$.xgafv'?: '1' | '2';
778
800
  /** OAuth access token. */
779
801
  access_token?: string;
780
802
  /** Data format for response. */
781
- alt?: string;
803
+ alt?: 'json' | 'media' | 'proto';
782
804
  /** JSONP */
783
805
  callback?: string;
784
806
  /** Selector specifying which fields to include in a partial response. */
@@ -803,11 +825,11 @@ declare namespace gapi.client {
803
825
  create(
804
826
  request: {
805
827
  /** V1 error format. */
806
- '$.xgafv'?: string;
828
+ '$.xgafv'?: '1' | '2';
807
829
  /** OAuth access token. */
808
830
  access_token?: string;
809
831
  /** Data format for response. */
810
- alt?: string;
832
+ alt?: 'json' | 'media' | 'proto';
811
833
  /** JSONP */
812
834
  callback?: string;
813
835
  /** Selector specifying which fields to include in a partial response. */
@@ -832,11 +854,11 @@ declare namespace gapi.client {
832
854
  /** Get a form. */
833
855
  get(request?: {
834
856
  /** V1 error format. */
835
- '$.xgafv'?: string;
857
+ '$.xgafv'?: '1' | '2';
836
858
  /** OAuth access token. */
837
859
  access_token?: string;
838
860
  /** Data format for response. */
839
- alt?: string;
861
+ alt?: 'json' | 'media' | 'proto';
840
862
  /** JSONP */
841
863
  callback?: string;
842
864
  /** Selector specifying which fields to include in a partial response. */
@@ -859,11 +881,11 @@ declare namespace gapi.client {
859
881
  /** Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field. */
860
882
  setPublishSettings(request: {
861
883
  /** V1 error format. */
862
- '$.xgafv'?: string;
884
+ '$.xgafv'?: '1' | '2';
863
885
  /** OAuth access token. */
864
886
  access_token?: string;
865
887
  /** Data format for response. */
866
- alt?: string;
888
+ alt?: 'json' | 'media' | 'proto';
867
889
  /** JSONP */
868
890
  callback?: string;
869
891
  /** Selector specifying which fields to include in a partial response. */
@@ -888,11 +910,11 @@ declare namespace gapi.client {
888
910
  setPublishSettings(
889
911
  request: {
890
912
  /** V1 error format. */
891
- '$.xgafv'?: string;
913
+ '$.xgafv'?: '1' | '2';
892
914
  /** OAuth access token. */
893
915
  access_token?: string;
894
916
  /** Data format for response. */
895
- alt?: string;
917
+ alt?: 'json' | 'media' | 'proto';
896
918
  /** JSONP */
897
919
  callback?: string;
898
920
  /** Selector specifying which fields to include in a partial response. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.forms-v1",
3
- "version": "0.1.20260311",
3
+ "version": "0.2.20260311",
4
4
  "description": "TypeScript typings for Google Forms API v1",
5
5
  "repository": {
6
6
  "type": "git",