@maxim_mazurok/gapi.client.forms-v1 0.0.20250218 → 0.0.20250304

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://forms.googleapis.com/$discovery/rest?version=v1
-// Revision: 20250218
+// Revision: 20250304
 
 /// <reference types="gapi.client" />
 
@@ -142,6 +142,8 @@ declare namespace gapi.client {
       items?: Item[];
       /** Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists). */
       linkedSheetId?: string;
+      /** Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form. */
+      publishSettings?: PublishSettings;
       /** Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. */
       responderUri?: string;
       /** Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes. */
@@ -278,6 +280,16 @@ declare namespace gapi.client {
       value?: string;
     }
     interface PageBreakItem {}
+    interface PublishSettings {
+      /** Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn't supported and returns an error. */
+      publishState?: PublishState;
+    }
+    interface PublishState {
+      /** Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`. */
+      isAcceptingResponses?: boolean;
+      /** Required. Whether the form is published and visible to others. */
+      isPublished?: boolean;
+    }
     interface Question {
       /** A respondent can choose from a pre-defined set of options. */
       choiceQuestion?: ChoiceQuestion;
@@ -359,6 +371,18 @@ declare namespace gapi.client {
       /** The label to display describing the lowest point on the scale. */
       lowLabel?: string;
     }
+    interface SetPublishSettingsRequest {
+      /** Required. The desired publish settings to apply to the form. */
+      publishSettings?: PublishSettings;
+      /** Optional. The `publish_settings` fields to update. This field mask accepts the following values: * `publish_state`: Updates or replaces all `publish_state` settings. * `"*"`: Updates or replaces all `publish_settings` fields. */
+      updateMask?: string;
+    }
+    interface SetPublishSettingsResponse {
+      /** Required. The ID of the Form. This is same as the `Form.form_id` field. */
+      formId?: string;
+      /** The publish settings of the form. */
+      publishSettings?: PublishSettings;
+    }
     interface TextAnswer {
       /** Output only. The answer value. Formatting used for different kinds of question: * ChoiceQuestion * `RADIO` or `DROP_DOWN`: A single string corresponding to the option that was selected. * `CHECKBOX`: Multiple strings corresponding to each option that was selected. * TextQuestion: The text that the user entered. * ScaleQuestion: A string containing the number that was selected. * DateQuestion * Without time or year: MM-DD e.g. "05-19" * With year: YYYY-MM-DD e.g. "1986-05-19" * With time: MM-DD HH:MM e.g. "05-19 14:51" * With year and time: YYYY-MM-DD HH:MM e.g. "1986-05-19 14:51" * TimeQuestion: String with time or duration in HH:MM format e.g. "14:51" * RowQuestion within QuestionGroupItem: The answer for each row of a QuestionGroupItem is represented as a separate Answer. Each will contain one string for `RADIO`-type choices or multiple strings for `CHECKBOX` choices. */
       value?: string;
@@ -767,6 +791,8 @@ declare namespace gapi.client {
         prettyPrint?: boolean;
         /** 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. */
         quotaUser?: string;
+        /** Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is published and accepts responses. */
+        unpublished?: boolean;
         /** Upload protocol for media (e.g. "raw", "multipart"). */
         upload_protocol?: string;
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -794,6 +820,8 @@ declare namespace gapi.client {
           prettyPrint?: boolean;
           /** 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. */
           quotaUser?: string;
+          /** Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is published and accepts responses. */
+          unpublished?: boolean;
           /** Upload protocol for media (e.g. "raw", "multipart"). */
           upload_protocol?: string;
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -828,6 +856,64 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): client.Request<Form>;
+      /** Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field. */
+      setPublishSettings(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Required. The ID of the form. You can get the id from `Form.form_id` field. */
+        formId: string;
+        /** 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. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** 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. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: SetPublishSettingsRequest;
+      }): client.Request<SetPublishSettingsResponse>;
+      setPublishSettings(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** Required. The ID of the form. You can get the id from `Form.form_id` field. */
+          formId: string;
+          /** 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. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** 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. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: SetPublishSettingsRequest,
+      ): client.Request<SetPublishSettingsResponse>;
       responses: ResponsesResource;
       watches: WatchesResource;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.forms-v1",
-  "version": "0.0.20250218",
+  "version": "0.0.20250304",
   "description": "TypeScript typings for Google Forms API v1",
   "repository": {
     "type": "git",

package/readme.md

@@ -98,4 +98,9 @@ await gapi.client.forms.forms.create({});
 Get a form.
 */
 await gapi.client.forms.forms.get({formId: 'formId'});
+
+/*
+Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field.
+*/
+await gapi.client.forms.forms.setPublishSettings({formId: 'formId'});
 ```