@maxim_mazurok/gapi.client.docs-v1 0.4.20260923 → 0.4.20260928

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://docs.googleapis.com/$discovery/rest?version=v1
-// Revision: 20260923
+// Revision: 20260928
 
 /// <reference types="gapi.client" />
 
@@ -150,6 +150,16 @@ declare namespace gapi.client {
       /** Whether the thread is open or resolved. */
       status?: 'STATUS_UNSPECIFIED' | 'OPEN' | 'RESOLVED';
     }
+    interface CreateDropdownDefinitionRequest {
+      /** Required. The DropdownDefinition to create. */
+      dropdownDefinition?: DropdownDefinition;
+      /** The ID of the tab to create the dropdown definition in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
+    }
+    interface CreateDropdownDefinitionResponse {
+      /** The newly-created DropdownDefinition. */
+      dropdownDefinition?: DropdownDefinition;
+    }
     interface CreateFooterRequest {
       /** The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style. */
       sectionBreakLocation?: Location;
@@ -306,6 +316,12 @@ declare namespace gapi.client {
       /** The range of content to delete. Deleting text that crosses a paragraph boundary may result in changes to paragraph styles, lists, positioned objects and bookmarks as the two paragraphs are merged. Attempting to delete certain ranges can result in an invalid document structure in which case a 400 bad request error is returned. Some examples of invalid delete requests include: * Deleting one code unit of a surrogate pair. * Deleting the last newline character of a Body, Header, Footer, Footnote, TableCell or TableOfContents. * Deleting the start or end of a Table, TableOfContents or Equation without deleting the entire element. * Deleting the newline character before a Table, TableOfContents or SectionBreak without deleting the element. * Deleting individual rows or cells of a table. Deleting the content within a table cell is allowed. */
       range?: Range;
     }
+    interface DeleteDropdownDefinitionRequest {
+      /** The ID of the DropdownDefinition to delete. */
+      dropdownDefinitionId?: string;
+      /** The ID of the tab that contains the dropdown definition to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
+    }
     interface DeleteFooterRequest {
       /** The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section. */
       footerId?: string;
@@ -501,6 +517,8 @@ declare namespace gapi.client {
       commentAnchors?: {[P in string]: CommentAnchor};
       /** The style of the document tab. */
       documentStyle?: DocumentStyle;
+      /** The dropdown definitions in a document tab, keyed by dropdown definition ID. */
+      dropdownDefinitions?: {[P in string]: DropdownDefinition};
       /** The footers in the document tab, keyed by footer ID. */
       footers?: {[P in string]: Footer};
       /** The footnotes in the document tab, keyed by footnote ID. */
@@ -522,6 +540,70 @@ declare namespace gapi.client {
       /** The suggested changes to the named styles of the document tab, keyed by suggestion ID. */
       suggestedNamedStylesChanges?: {[P in string]: SuggestedNamedStyles};
     }
+    interface Dropdown {
+      /** The ID of this dropdown. */
+      dropdownId?: string;
+      /** The properties of this dropdown. */
+      dropdownProperties?: DropdownProperties;
+      /** IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. */
+      suggestedDeletionIds?: string[];
+      /** The suggested properties changes to this dropdown, keyed by suggestion ID. */
+      suggestedDropdownPropertiesChanges?: {
+        [P in string]: SuggestedDropdownProperties;
+      };
+      /** IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. */
+      suggestedInsertionIds?: string[];
+      /** The suggested text style changes to this dropdown, keyed by suggestion ID. */
+      suggestedTextStyleChanges?: {[P in string]: SuggestedTextStyle};
+      /** The text style of this dropdown. */
+      textStyle?: TextStyle;
+    }
+    interface DropdownDefinition {
+      /** The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated. */
+      dropdownDefinitionId?: string;
+      /** The properties of this dropdown definition. */
+      dropdownDefinitionProperties?: DropdownDefinitionProperties;
+      /** ID for suggestion that deletes this dropdown definition. */
+      suggestedDeletionId?: string;
+      /** Suggested property changes to this definition, keyed by suggestion ID. */
+      suggestedDropdownDefinitionPropertiesChanges?: {
+        [P in string]: SuggestedDropdownDefinitionProperties;
+      };
+      /** ID for suggestion that inserts this dropdown definition. */
+      suggestedInsertionId?: string;
+    }
+    interface DropdownDefinitionProperties {
+      /** The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. */
+      options?: DropdownOption[];
+      /** The title of the dropdown definition. */
+      title?: string;
+    }
+    interface DropdownDefinitionPropertiesSuggestionState {
+      /** Indicates if there was a suggested change to options. */
+      optionsSuggested?: boolean;
+      /** Indicates if there was a suggested change to title. */
+      titleSuggested?: boolean;
+    }
+    interface DropdownOption {
+      /** The display value of this dropdown option. */
+      displayValue?: string;
+      /** The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. */
+      optionId?: string;
+      /** The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. */
+      textStyle?: TextStyle;
+    }
+    interface DropdownProperties {
+      /** The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. */
+      displayValue?: string;
+      /** The ID of the DropdownDefinition that defines the options for this dropdown. */
+      dropdownDefinitionId?: string;
+      /** The ID of the selected option in this dropdown. */
+      selectedOptionId?: string;
+    }
+    interface DropdownPropertiesSuggestionState {
+      /** Indicates if there was a suggested change to selected_option_id. */
+      selectedOptionIdSuggested?: boolean;
+    }
     interface EmbeddedDrawingProperties {}
     interface EmbeddedDrawingPropertiesSuggestionState {}
     interface EmbeddedObject {
@@ -738,6 +820,20 @@ declare namespace gapi.client {
       /** Inserts the date at a specific index in the document. The date must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between an existing table and its preceding paragraph). */
       location?: Location;
     }
+    interface InsertDropdownRequest {
+      /** Required. The DropdownDefinition ID. */
+      dropdownDefinitionId?: string;
+      /** The EndOfSegmentLocation in the document to insert the dropdown at. */
+      endOfSegmentLocation?: EndOfSegmentLocation;
+      /** The Location in the document to insert the dropdown at. */
+      location?: Location;
+      /** Optional initial value for the dropdown. If this field is not specified, the new dropdown will default to selecting the first option defined in the dropdown definition. If this field is specified but does not reference a valid option in the dropdown definition, a 400 bad request error is returned. */
+      selectedOptionId?: string;
+    }
+    interface InsertDropdownResponse {
+      /** The newly-inserted Dropdown. */
+      dropdown?: Dropdown;
+    }
     interface InsertInlineImageRequest {
       /** Inserts the text at the end of a header, footer or the document body. Inline images cannot be inserted inside a footnote. */
       endOfSegmentLocation?: EndOfSegmentLocation;
@@ -1022,6 +1118,8 @@ declare namespace gapi.client {
       columnBreak?: ColumnBreak;
       /** A paragraph element that represents a date. */
       dateElement?: DateElement;
+      /** A paragraph element that represents a dropdown menu. */
+      dropdown?: Dropdown;
       /** The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. */
       endIndex?: number;
       /** An equation paragraph element. */
@@ -1320,6 +1418,8 @@ declare namespace gapi.client {
       addCommentReply?: AddCommentReplyRequest;
       /** Adds a document tab. */
       addDocumentTab?: AddDocumentTabRequest;
+      /** Creates a DropdownDefinition. */
+      createDropdownDefinition?: CreateDropdownDefinitionRequest;
       /** Creates a footer. */
       createFooter?: CreateFooterRequest;
       /** Creates a footnote. */
@@ -1336,6 +1436,8 @@ declare namespace gapi.client {
       deleteCommentReply?: DeleteCommentReplyRequest;
       /** Deletes content from the document. */
       deleteContentRange?: DeleteContentRangeRequest;
+      /** Deletes a DropdownDefinition. */
+      deleteDropdownDefinition?: DeleteDropdownDefinitionRequest;
       /** Deletes a footer from the document. */
       deleteFooter?: DeleteFooterRequest;
       /** Deletes a header from the document. */
@@ -1358,6 +1460,8 @@ declare namespace gapi.client {
       insertComment?: InsertCommentRequest;
       /** Inserts a date. */
       insertDate?: InsertDateRequest;
+      /** Inserts a Dropdown at the specified location. */
+      insertDropdown?: InsertDropdownRequest;
       /** Inserts an inline image at the specified location. */
       insertInlineImage?: InsertInlineImageRequest;
       /** Inserts a page break at the specified location. */
@@ -1396,6 +1500,10 @@ declare namespace gapi.client {
       updateDocumentStyle?: UpdateDocumentStyleRequest;
       /** Updates the properties of a document tab. */
       updateDocumentTabProperties?: UpdateDocumentTabPropertiesRequest;
+      /** Updates the properties of a DropdownDefinition. */
+      updateDropdownDefinitionProperties?: UpdateDropdownDefinitionPropertiesRequest;
+      /** Updates the properties of a Dropdown. */
+      updateDropdownProperties?: UpdateDropdownPropertiesRequest;
       /** Updates a named style. */
       updateNamedStyle?: UpdateNamedStyleRequest;
       /** Updates the paragraph style at the specified range. */
@@ -1416,6 +1524,8 @@ declare namespace gapi.client {
       addCommentReply?: AddCommentReplyResponse;
       /** The result of adding a document tab. */
       addDocumentTab?: AddDocumentTabResponse;
+      /** The result of creating a dropdown definition. */
+      createDropdownDefinition?: CreateDropdownDefinitionResponse;
       /** The result of creating a footer. */
       createFooter?: CreateFooterResponse;
       /** The result of creating a footnote. */
@@ -1426,6 +1536,8 @@ declare namespace gapi.client {
       createNamedRange?: CreateNamedRangeResponse;
       /** The result of inserting a comment. [Developer Preview](https://developers.google.com/workspace/preview). */
       insertComment?: InsertCommentResponse;
+      /** The result of inserting a dropdown. */
+      insertDropdown?: InsertDropdownResponse;
       /** The result of inserting an inline image. */
       insertInlineImage?: InsertInlineImageResponse;
       /** The result of inserting an inline Google Sheets chart. */
@@ -1591,6 +1703,18 @@ declare namespace gapi.client {
       /** A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. */
       documentStyleSuggestionState?: DocumentStyleSuggestionState;
     }
+    interface SuggestedDropdownDefinitionProperties {
+      /** A DropdownDefinitionProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_definition_properties_suggestion_state to see which fields have changed and their new values. */
+      dropdownDefinitionProperties?: DropdownDefinitionProperties;
+      /** A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. */
+      dropdownDefinitionPropertiesSuggestionState?: DropdownDefinitionPropertiesSuggestionState;
+    }
+    interface SuggestedDropdownProperties {
+      /** A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. */
+      dropdownProperties?: DropdownProperties;
+      /** A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. */
+      dropdownPropertiesSuggestionState?: DropdownPropertiesSuggestionState;
+    }
     interface SuggestedInlineObjectProperties {
       /** An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. */
       inlineObjectProperties?: InlineObjectProperties;
@@ -1944,6 +2068,28 @@ declare namespace gapi.client {
       /** The tab properties to update. */
       tabProperties?: TabProperties;
     }
+    interface UpdateDropdownDefinitionPropertiesRequest {
+      /** The ID of the DropdownDefinition to update. */
+      dropdownDefinitionId?: string;
+      /** The properties to update. */
+      dropdownDefinitionProperties?: DropdownDefinitionProperties;
+      /** The fields that should be updated. At least one field must be specified. The root `dropdown_definition_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. When `dropdown_definition_properties.options` is included in the field mask, the full, complete list of desired options must be provided in `dropdown_definition_properties.options`. */
+      fields?: string;
+      /** A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted. The keys are the IDs of the options being deleted, and the values are the IDs of their replacement options. If an option being deleted is selected in one or more Dropdown chips in the document, a replacement entry for that option must be provided in this map, and the replacement option ID must exist in the updated DropdownDefinition. If a replacement is required but not provided, a 400 bad request error is returned. Options being deleted that are not selected in any Dropdown chips do not require a replacement. For example, if option A is being replaced by option B, the map should be `{"A": "B"}`. */
+      selectedOptionIdReplacements?: {[P in string]: string};
+      /** The ID of the tab that contains the dropdown definition to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
+    }
+    interface UpdateDropdownPropertiesRequest {
+      /** Required. The Dropdown ID. */
+      dropdownId?: string;
+      /** The properties to update. */
+      dropdownProperties?: DropdownProperties;
+      /** The fields that should be updated. At least one field must be specified. The root `dropdown_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */
+      fields?: string;
+      /** The ID of the tab that contains the dropdown to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
+    }
     interface UpdateNamedStyleRequest {
       /** The NamedStyle fields that should be updated. At least `named_style_type` must be specified. The root `named_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to include `"text_style"` and `"text_style.bold"`. To update the paragraph style's alignment property, set `fields` to include `"paragraph_style"` and `"paragraph_style.alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. Specifying `"text_style"` or `"paragraph_style"` with an empty TextStyle or ParagraphStyle will reset all of its nested fields. */
       fields?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.docs-v1",
-  "version": "0.4.20260923",
+  "version": "0.4.20260928",
   "description": "TypeScript typings for Google Docs API v1",
   "repository": {
     "type": "git",