google-apis-docs_v1 0.27.0 → 0.28.0

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d38d412de210fbbb179280f983f165d3094faf47644c2942cc2d3c7511cb6bf4
4
- data.tar.gz: a18c06cb27de5f6a5a5f167d64df73892bf825fa9de5c8ddd10547cbd8ab4c3d
3
+ metadata.gz: b9112afa252a6d614924717856b382beeacf68c8d5121f3de1ad0e6e08401402
4
+ data.tar.gz: 673be4169151c4f3e4bb56f9951a5b69c3b85804ae364a99e264efbb976d6ea9
5
5
  SHA512:
6
- metadata.gz: a250f70cabf56fd28456ab3d54df883a6ab08abdc7ced3e863a8f098a631740458fb529700790204795b2d0438d98794a0d2d863d339736fd335c7cc11f02515
7
- data.tar.gz: aace5932755340e96005845e0c1be6ee8ccb28eb1d399bc68edbf40b83179745d6976fb47b32634aa7670f257a1c1b5dda60283641e77f31152c60e923c69931
6
+ metadata.gz: 9026ffd2eb6f120dd20f52b3ff8436c61cf904020fba1cd14a66d814954eec9d7f79b43889882b4e08eabc9f1ac66457cda814ff7c932262b38c9473df68240d
7
+ data.tar.gz: de8b15af71ddcaf19e5e2e2b15bce777e85b92e6d580531535f6aa53282326241a19a9d508696c42c5850448e04e92d6d445c2208b26e7b78d32d396265ac337
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-docs_v1
2
2
 
3
+ ### v0.28.0 (2024-07-25)
4
+
5
+ * Regenerated from discovery document revision 20240722
6
+
3
7
  ### v0.27.0 (2024-05-19)
4
8
 
5
9
  * Regenerated using generator version 0.15.0
@@ -196,6 +196,31 @@ module Google
196
196
  end
197
197
  end
198
198
 
199
+ # A reference to a bookmark in this document.
200
+ class BookmarkLink
201
+ include Google::Apis::Core::Hashable
202
+
203
+ # The ID of a bookmark in this document.
204
+ # Corresponds to the JSON property `id`
205
+ # @return [String]
206
+ attr_accessor :id
207
+
208
+ # The ID of the tab containing this bookmark.
209
+ # Corresponds to the JSON property `tabId`
210
+ # @return [String]
211
+ attr_accessor :tab_id
212
+
213
+ def initialize(**args)
214
+ update!(**args)
215
+ end
216
+
217
+ # Update properties of this object
218
+ def update!(**args)
219
+ @id = args[:id] if args.key?(:id)
220
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
221
+ end
222
+ end
223
+
199
224
  # Describes the bullet of a paragraph.
200
225
  class Bullet
201
226
  include Google::Apis::Core::Hashable
@@ -699,6 +724,16 @@ module Google
699
724
  # @return [String]
700
725
  attr_accessor :footer_id
701
726
 
727
+ # The tab that contains the footer to delete. When omitted, the request is
728
+ # applied to the first tab. In a document containing a single tab: - If provided,
729
+ # must match the singular tab's ID. - If omitted, the request applies to the
730
+ # singular tab. In a document containing multiple tabs: - If provided, the
731
+ # request applies to the specified tab. - If omitted, the request applies to the
732
+ # first tab in the document.
733
+ # Corresponds to the JSON property `tabId`
734
+ # @return [String]
735
+ attr_accessor :tab_id
736
+
702
737
  def initialize(**args)
703
738
  update!(**args)
704
739
  end
@@ -706,6 +741,7 @@ module Google
706
741
  # Update properties of this object
707
742
  def update!(**args)
708
743
  @footer_id = args[:footer_id] if args.key?(:footer_id)
744
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
709
745
  end
710
746
  end
711
747
 
@@ -722,6 +758,16 @@ module Google
722
758
  # @return [String]
723
759
  attr_accessor :header_id
724
760
 
761
+ # The tab containing the header to delete. When omitted, the request is applied
762
+ # to the first tab. In a document containing a single tab: - If provided, must
763
+ # match the singular tab's ID. - If omitted, the request applies to the singular
764
+ # tab. In a document containing multiple tabs: - If provided, the request
765
+ # applies to the specified tab. - If omitted, the request applies to the first
766
+ # tab in the document.
767
+ # Corresponds to the JSON property `tabId`
768
+ # @return [String]
769
+ attr_accessor :tab_id
770
+
725
771
  def initialize(**args)
726
772
  update!(**args)
727
773
  end
@@ -729,6 +775,7 @@ module Google
729
775
  # Update properties of this object
730
776
  def update!(**args)
731
777
  @header_id = args[:header_id] if args.key?(:header_id)
778
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
732
779
  end
733
780
  end
734
781
 
@@ -747,6 +794,11 @@ module Google
747
794
  # @return [String]
748
795
  attr_accessor :named_range_id
749
796
 
797
+ # A criteria that specifies in which tabs a request executes.
798
+ # Corresponds to the JSON property `tabsCriteria`
799
+ # @return [Google::Apis::DocsV1::TabsCriteria]
800
+ attr_accessor :tabs_criteria
801
+
750
802
  def initialize(**args)
751
803
  update!(**args)
752
804
  end
@@ -755,6 +807,7 @@ module Google
755
807
  def update!(**args)
756
808
  @name = args[:name] if args.key?(:name)
757
809
  @named_range_id = args[:named_range_id] if args.key?(:named_range_id)
810
+ @tabs_criteria = args[:tabs_criteria] if args.key?(:tabs_criteria)
758
811
  end
759
812
  end
760
813
 
@@ -788,6 +841,16 @@ module Google
788
841
  # @return [String]
789
842
  attr_accessor :object_id_prop
790
843
 
844
+ # The tab that the positioned object to delete is in. When omitted, the request
845
+ # is applied to the first tab. In a document containing a single tab: - If
846
+ # provided, must match the singular tab's ID. - If omitted, the request applies
847
+ # to the singular tab. In a document containing multiple tabs: - If provided,
848
+ # the request applies to the specified tab. - If omitted, the request applies to
849
+ # the first tab in the document.
850
+ # Corresponds to the JSON property `tabId`
851
+ # @return [String]
852
+ attr_accessor :tab_id
853
+
791
854
  def initialize(**args)
792
855
  update!(**args)
793
856
  end
@@ -795,6 +858,7 @@ module Google
795
858
  # Update properties of this object
796
859
  def update!(**args)
797
860
  @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop)
861
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
798
862
  end
799
863
  end
800
864
 
@@ -956,6 +1020,12 @@ module Google
956
1020
  # @return [String]
957
1021
  attr_accessor :suggestions_view_mode
958
1022
 
1023
+ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested
1024
+ # within another tab. Child tabs are represented by the Tab.child_tabs field.
1025
+ # Corresponds to the JSON property `tabs`
1026
+ # @return [Array<Google::Apis::DocsV1::Tab>]
1027
+ attr_accessor :tabs
1028
+
959
1029
  # The title of the document.
960
1030
  # Corresponds to the JSON property `title`
961
1031
  # @return [String]
@@ -982,6 +1052,7 @@ module Google
982
1052
  @suggested_document_style_changes = args[:suggested_document_style_changes] if args.key?(:suggested_document_style_changes)
983
1053
  @suggested_named_styles_changes = args[:suggested_named_styles_changes] if args.key?(:suggested_named_styles_changes)
984
1054
  @suggestions_view_mode = args[:suggestions_view_mode] if args.key?(:suggestions_view_mode)
1055
+ @tabs = args[:tabs] if args.key?(:tabs)
985
1056
  @title = args[:title] if args.key?(:title)
986
1057
  end
987
1058
  end
@@ -1287,6 +1358,94 @@ module Google
1287
1358
  end
1288
1359
  end
1289
1360
 
1361
+ # A tab with document contents.
1362
+ class DocumentTab
1363
+ include Google::Apis::Core::Hashable
1364
+
1365
+ # The document body. The body typically contains the full document contents
1366
+ # except for headers, footers, and footnotes.
1367
+ # Corresponds to the JSON property `body`
1368
+ # @return [Google::Apis::DocsV1::Body]
1369
+ attr_accessor :body
1370
+
1371
+ # The style of the document.
1372
+ # Corresponds to the JSON property `documentStyle`
1373
+ # @return [Google::Apis::DocsV1::DocumentStyle]
1374
+ attr_accessor :document_style
1375
+
1376
+ # The footers in the document tab, keyed by footer ID.
1377
+ # Corresponds to the JSON property `footers`
1378
+ # @return [Hash<String,Google::Apis::DocsV1::Footer>]
1379
+ attr_accessor :footers
1380
+
1381
+ # The footnotes in the document tab, keyed by footnote ID.
1382
+ # Corresponds to the JSON property `footnotes`
1383
+ # @return [Hash<String,Google::Apis::DocsV1::Footnote>]
1384
+ attr_accessor :footnotes
1385
+
1386
+ # The headers in the document tab, keyed by header ID.
1387
+ # Corresponds to the JSON property `headers`
1388
+ # @return [Hash<String,Google::Apis::DocsV1::Header>]
1389
+ attr_accessor :headers
1390
+
1391
+ # The inline objects in the document tab, keyed by object ID.
1392
+ # Corresponds to the JSON property `inlineObjects`
1393
+ # @return [Hash<String,Google::Apis::DocsV1::InlineObject>]
1394
+ attr_accessor :inline_objects
1395
+
1396
+ # The lists in the document tab, keyed by list ID.
1397
+ # Corresponds to the JSON property `lists`
1398
+ # @return [Hash<String,Google::Apis::DocsV1::List>]
1399
+ attr_accessor :lists
1400
+
1401
+ # The named ranges in the document tab, keyed by name.
1402
+ # Corresponds to the JSON property `namedRanges`
1403
+ # @return [Hash<String,Google::Apis::DocsV1::NamedRanges>]
1404
+ attr_accessor :named_ranges
1405
+
1406
+ # The named styles. Paragraphs in the document can inherit their TextStyle and
1407
+ # ParagraphStyle from these named styles.
1408
+ # Corresponds to the JSON property `namedStyles`
1409
+ # @return [Google::Apis::DocsV1::NamedStyles]
1410
+ attr_accessor :named_styles
1411
+
1412
+ # The positioned objects in the document tab, keyed by object ID.
1413
+ # Corresponds to the JSON property `positionedObjects`
1414
+ # @return [Hash<String,Google::Apis::DocsV1::PositionedObject>]
1415
+ attr_accessor :positioned_objects
1416
+
1417
+ # The suggested changes to the style of the document tab, keyed by suggestion ID.
1418
+ # Corresponds to the JSON property `suggestedDocumentStyleChanges`
1419
+ # @return [Hash<String,Google::Apis::DocsV1::SuggestedDocumentStyle>]
1420
+ attr_accessor :suggested_document_style_changes
1421
+
1422
+ # The suggested changes to the named styles of the document tab, keyed by
1423
+ # suggestion ID.
1424
+ # Corresponds to the JSON property `suggestedNamedStylesChanges`
1425
+ # @return [Hash<String,Google::Apis::DocsV1::SuggestedNamedStyles>]
1426
+ attr_accessor :suggested_named_styles_changes
1427
+
1428
+ def initialize(**args)
1429
+ update!(**args)
1430
+ end
1431
+
1432
+ # Update properties of this object
1433
+ def update!(**args)
1434
+ @body = args[:body] if args.key?(:body)
1435
+ @document_style = args[:document_style] if args.key?(:document_style)
1436
+ @footers = args[:footers] if args.key?(:footers)
1437
+ @footnotes = args[:footnotes] if args.key?(:footnotes)
1438
+ @headers = args[:headers] if args.key?(:headers)
1439
+ @inline_objects = args[:inline_objects] if args.key?(:inline_objects)
1440
+ @lists = args[:lists] if args.key?(:lists)
1441
+ @named_ranges = args[:named_ranges] if args.key?(:named_ranges)
1442
+ @named_styles = args[:named_styles] if args.key?(:named_styles)
1443
+ @positioned_objects = args[:positioned_objects] if args.key?(:positioned_objects)
1444
+ @suggested_document_style_changes = args[:suggested_document_style_changes] if args.key?(:suggested_document_style_changes)
1445
+ @suggested_named_styles_changes = args[:suggested_named_styles_changes] if args.key?(:suggested_named_styles_changes)
1446
+ end
1447
+ end
1448
+
1290
1449
  # The properties of an embedded drawing and used to differentiate the object
1291
1450
  # type. An embedded drawing is one that's created and edited within a document.
1292
1451
  # Note that extensive details are not supported.
@@ -1588,6 +1747,16 @@ module Google
1588
1747
  # @return [String]
1589
1748
  attr_accessor :segment_id
1590
1749
 
1750
+ # The tab that the location is in. When omitted, the request is applied to the
1751
+ # first tab. In a document containing a single tab: - If provided, must match
1752
+ # the singular tab's ID. - If omitted, the request applies to the singular tab.
1753
+ # In a document containing multiple tabs: - If provided, the request applies to
1754
+ # the specified tab. - If omitted, the request applies to the first tab in the
1755
+ # document.
1756
+ # Corresponds to the JSON property `tabId`
1757
+ # @return [String]
1758
+ attr_accessor :tab_id
1759
+
1591
1760
  def initialize(**args)
1592
1761
  update!(**args)
1593
1762
  end
@@ -1595,6 +1764,7 @@ module Google
1595
1764
  # Update properties of this object
1596
1765
  def update!(**args)
1597
1766
  @segment_id = args[:segment_id] if args.key?(:segment_id)
1767
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
1598
1768
  end
1599
1769
  end
1600
1770
 
@@ -1764,6 +1934,31 @@ module Google
1764
1934
  end
1765
1935
  end
1766
1936
 
1937
+ # A reference to a heading in this document.
1938
+ class HeadingLink
1939
+ include Google::Apis::Core::Hashable
1940
+
1941
+ # The ID of a heading in this document.
1942
+ # Corresponds to the JSON property `id`
1943
+ # @return [String]
1944
+ attr_accessor :id
1945
+
1946
+ # The ID of the tab containing this heading.
1947
+ # Corresponds to the JSON property `tabId`
1948
+ # @return [String]
1949
+ attr_accessor :tab_id
1950
+
1951
+ def initialize(**args)
1952
+ update!(**args)
1953
+ end
1954
+
1955
+ # Update properties of this object
1956
+ def update!(**args)
1957
+ @id = args[:id] if args.key?(:id)
1958
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
1959
+ end
1960
+ end
1961
+
1767
1962
  # A ParagraphElement representing a horizontal line.
1768
1963
  class HorizontalRule
1769
1964
  include Google::Apis::Core::Hashable
@@ -2366,16 +2561,31 @@ module Google
2366
2561
  class Link
2367
2562
  include Google::Apis::Core::Hashable
2368
2563
 
2564
+ # A reference to a bookmark in this document.
2565
+ # Corresponds to the JSON property `bookmark`
2566
+ # @return [Google::Apis::DocsV1::BookmarkLink]
2567
+ attr_accessor :bookmark
2568
+
2369
2569
  # The ID of a bookmark in this document.
2370
2570
  # Corresponds to the JSON property `bookmarkId`
2371
2571
  # @return [String]
2372
2572
  attr_accessor :bookmark_id
2373
2573
 
2574
+ # A reference to a heading in this document.
2575
+ # Corresponds to the JSON property `heading`
2576
+ # @return [Google::Apis::DocsV1::HeadingLink]
2577
+ attr_accessor :heading
2578
+
2374
2579
  # The ID of a heading in this document.
2375
2580
  # Corresponds to the JSON property `headingId`
2376
2581
  # @return [String]
2377
2582
  attr_accessor :heading_id
2378
2583
 
2584
+ # The ID of a tab in this document.
2585
+ # Corresponds to the JSON property `tabId`
2586
+ # @return [String]
2587
+ attr_accessor :tab_id
2588
+
2379
2589
  # An external URL.
2380
2590
  # Corresponds to the JSON property `url`
2381
2591
  # @return [String]
@@ -2387,8 +2597,11 @@ module Google
2387
2597
 
2388
2598
  # Update properties of this object
2389
2599
  def update!(**args)
2600
+ @bookmark = args[:bookmark] if args.key?(:bookmark)
2390
2601
  @bookmark_id = args[:bookmark_id] if args.key?(:bookmark_id)
2602
+ @heading = args[:heading] if args.key?(:heading)
2391
2603
  @heading_id = args[:heading_id] if args.key?(:heading_id)
2604
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
2392
2605
  @url = args[:url] if args.key?(:url)
2393
2606
  end
2394
2607
  end
@@ -2539,6 +2752,16 @@ module Google
2539
2752
  # @return [String]
2540
2753
  attr_accessor :segment_id
2541
2754
 
2755
+ # The tab that the location is in. When omitted, the request is applied to the
2756
+ # first tab. In a document containing a single tab: - If provided, must match
2757
+ # the singular tab's ID. - If omitted, the request applies to the singular tab.
2758
+ # In a document containing multiple tabs: - If provided, the request applies to
2759
+ # the specified tab. - If omitted, the request applies to the first tab in the
2760
+ # document.
2761
+ # Corresponds to the JSON property `tabId`
2762
+ # @return [String]
2763
+ attr_accessor :tab_id
2764
+
2542
2765
  def initialize(**args)
2543
2766
  update!(**args)
2544
2767
  end
@@ -2547,6 +2770,7 @@ module Google
2547
2770
  def update!(**args)
2548
2771
  @index = args[:index] if args.key?(:index)
2549
2772
  @segment_id = args[:segment_id] if args.key?(:segment_id)
2773
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
2550
2774
  end
2551
2775
  end
2552
2776
 
@@ -3873,6 +4097,16 @@ module Google
3873
4097
  # @return [Fixnum]
3874
4098
  attr_accessor :start_index
3875
4099
 
4100
+ # The tab that contains this range. When omitted, the request applies to the
4101
+ # first tab. In a document containing a single tab: - If provided, must match
4102
+ # the singular tab's ID. - If omitted, the request applies to the singular tab.
4103
+ # In a document containing multiple tabs: - If provided, the request applies to
4104
+ # the specified tab. - If omitted, the request applies to the first tab in the
4105
+ # document.
4106
+ # Corresponds to the JSON property `tabId`
4107
+ # @return [String]
4108
+ attr_accessor :tab_id
4109
+
3876
4110
  def initialize(**args)
3877
4111
  update!(**args)
3878
4112
  end
@@ -3882,6 +4116,7 @@ module Google
3882
4116
  @end_index = args[:end_index] if args.key?(:end_index)
3883
4117
  @segment_id = args[:segment_id] if args.key?(:segment_id)
3884
4118
  @start_index = args[:start_index] if args.key?(:start_index)
4119
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
3885
4120
  end
3886
4121
  end
3887
4122
 
@@ -3899,6 +4134,11 @@ module Google
3899
4134
  # @return [String]
3900
4135
  attr_accessor :replace_text
3901
4136
 
4137
+ # A criteria that specifies in which tabs a request executes.
4138
+ # Corresponds to the JSON property `tabsCriteria`
4139
+ # @return [Google::Apis::DocsV1::TabsCriteria]
4140
+ attr_accessor :tabs_criteria
4141
+
3902
4142
  def initialize(**args)
3903
4143
  update!(**args)
3904
4144
  end
@@ -3907,6 +4147,7 @@ module Google
3907
4147
  def update!(**args)
3908
4148
  @contains_text = args[:contains_text] if args.key?(:contains_text)
3909
4149
  @replace_text = args[:replace_text] if args.key?(:replace_text)
4150
+ @tabs_criteria = args[:tabs_criteria] if args.key?(:tabs_criteria)
3910
4151
  end
3911
4152
  end
3912
4153
 
@@ -3946,6 +4187,16 @@ module Google
3946
4187
  # @return [String]
3947
4188
  attr_accessor :image_replace_method
3948
4189
 
4190
+ # The tab that the image to be replaced is in. When omitted, the request is
4191
+ # applied to the first tab. In a document containing a single tab: - If provided,
4192
+ # must match the singular tab's ID. - If omitted, the request applies to the
4193
+ # singular tab. In a document containing multiple tabs: - If provided, the
4194
+ # request applies to the specified tab. - If omitted, the request applies to the
4195
+ # first tab in the document.
4196
+ # Corresponds to the JSON property `tabId`
4197
+ # @return [String]
4198
+ attr_accessor :tab_id
4199
+
3949
4200
  # The URI of the new image. The image is fetched once at insertion time and a
3950
4201
  # copy is stored for display inside the document. Images must be less than 50MB,
3951
4202
  # cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The
@@ -3963,6 +4214,7 @@ module Google
3963
4214
  def update!(**args)
3964
4215
  @image_object_id = args[:image_object_id] if args.key?(:image_object_id)
3965
4216
  @image_replace_method = args[:image_replace_method] if args.key?(:image_replace_method)
4217
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
3966
4218
  @uri = args[:uri] if args.key?(:uri)
3967
4219
  end
3968
4220
  end
@@ -3990,6 +4242,11 @@ module Google
3990
4242
  # @return [String]
3991
4243
  attr_accessor :named_range_name
3992
4244
 
4245
+ # A criteria that specifies in which tabs a request executes.
4246
+ # Corresponds to the JSON property `tabsCriteria`
4247
+ # @return [Google::Apis::DocsV1::TabsCriteria]
4248
+ attr_accessor :tabs_criteria
4249
+
3993
4250
  # Replaces the content of the specified named range(s) with the given text.
3994
4251
  # Corresponds to the JSON property `text`
3995
4252
  # @return [String]
@@ -4003,6 +4260,7 @@ module Google
4003
4260
  def update!(**args)
4004
4261
  @named_range_id = args[:named_range_id] if args.key?(:named_range_id)
4005
4262
  @named_range_name = args[:named_range_name] if args.key?(:named_range_name)
4263
+ @tabs_criteria = args[:tabs_criteria] if args.key?(:tabs_criteria)
4006
4264
  @text = args[:text] if args.key?(:text)
4007
4265
  end
4008
4266
  end
@@ -5185,6 +5443,82 @@ module Google
5185
5443
  end
5186
5444
  end
5187
5445
 
5446
+ # A tab in a document.
5447
+ class Tab
5448
+ include Google::Apis::Core::Hashable
5449
+
5450
+ # The child tabs nested within this tab.
5451
+ # Corresponds to the JSON property `childTabs`
5452
+ # @return [Array<Google::Apis::DocsV1::Tab>]
5453
+ attr_accessor :child_tabs
5454
+
5455
+ # A tab with document contents.
5456
+ # Corresponds to the JSON property `documentTab`
5457
+ # @return [Google::Apis::DocsV1::DocumentTab]
5458
+ attr_accessor :document_tab
5459
+
5460
+ # Properties of a tab.
5461
+ # Corresponds to the JSON property `tabProperties`
5462
+ # @return [Google::Apis::DocsV1::TabProperties]
5463
+ attr_accessor :tab_properties
5464
+
5465
+ def initialize(**args)
5466
+ update!(**args)
5467
+ end
5468
+
5469
+ # Update properties of this object
5470
+ def update!(**args)
5471
+ @child_tabs = args[:child_tabs] if args.key?(:child_tabs)
5472
+ @document_tab = args[:document_tab] if args.key?(:document_tab)
5473
+ @tab_properties = args[:tab_properties] if args.key?(:tab_properties)
5474
+ end
5475
+ end
5476
+
5477
+ # Properties of a tab.
5478
+ class TabProperties
5479
+ include Google::Apis::Core::Hashable
5480
+
5481
+ # The index of the tab within the parent.
5482
+ # Corresponds to the JSON property `index`
5483
+ # @return [Fixnum]
5484
+ attr_accessor :index
5485
+
5486
+ # Output only. The depth of the tab within the document. Root-level tabs start
5487
+ # at 0.
5488
+ # Corresponds to the JSON property `nestingLevel`
5489
+ # @return [Fixnum]
5490
+ attr_accessor :nesting_level
5491
+
5492
+ # Optional. The ID of the parent tab. Empty when the current tab is a root-level
5493
+ # tab, which means it doesn't have any parents.
5494
+ # Corresponds to the JSON property `parentTabId`
5495
+ # @return [String]
5496
+ attr_accessor :parent_tab_id
5497
+
5498
+ # Output only. The ID of the tab. This field can't be changed.
5499
+ # Corresponds to the JSON property `tabId`
5500
+ # @return [String]
5501
+ attr_accessor :tab_id
5502
+
5503
+ # The user-visible name of the tab.
5504
+ # Corresponds to the JSON property `title`
5505
+ # @return [String]
5506
+ attr_accessor :title
5507
+
5508
+ def initialize(**args)
5509
+ update!(**args)
5510
+ end
5511
+
5512
+ # Update properties of this object
5513
+ def update!(**args)
5514
+ @index = args[:index] if args.key?(:index)
5515
+ @nesting_level = args[:nesting_level] if args.key?(:nesting_level)
5516
+ @parent_tab_id = args[:parent_tab_id] if args.key?(:parent_tab_id)
5517
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
5518
+ @title = args[:title] if args.key?(:title)
5519
+ end
5520
+ end
5521
+
5188
5522
  # A tab stop within a paragraph.
5189
5523
  class TabStop
5190
5524
  include Google::Apis::Core::Hashable
@@ -5805,6 +6139,25 @@ module Google
5805
6139
  end
5806
6140
  end
5807
6141
 
6142
+ # A criteria that specifies in which tabs a request executes.
6143
+ class TabsCriteria
6144
+ include Google::Apis::Core::Hashable
6145
+
6146
+ # The list of tab IDs in which the request executes.
6147
+ # Corresponds to the JSON property `tabIds`
6148
+ # @return [Array<String>]
6149
+ attr_accessor :tab_ids
6150
+
6151
+ def initialize(**args)
6152
+ update!(**args)
6153
+ end
6154
+
6155
+ # Update properties of this object
6156
+ def update!(**args)
6157
+ @tab_ids = args[:tab_ids] if args.key?(:tab_ids)
6158
+ end
6159
+ end
6160
+
5808
6161
  # A ParagraphElement that represents a run of text that all has the same styling.
5809
6162
  class TextRun
5810
6163
  include Google::Apis::Core::Hashable
@@ -6089,6 +6442,16 @@ module Google
6089
6442
  # @return [String]
6090
6443
  attr_accessor :fields
6091
6444
 
6445
+ # The tab that contains the style to update. When omitted, the request applies
6446
+ # to the first tab. In a document containing a single tab: - If provided, must
6447
+ # match the singular tab's ID. - If omitted, the request applies to the singular
6448
+ # tab. In a document containing multiple tabs: - If provided, the request
6449
+ # applies to the specified tab. - If not provided, the request applies to the
6450
+ # first tab in the document.
6451
+ # Corresponds to the JSON property `tabId`
6452
+ # @return [String]
6453
+ attr_accessor :tab_id
6454
+
6092
6455
  def initialize(**args)
6093
6456
  update!(**args)
6094
6457
  end
@@ -6097,6 +6460,7 @@ module Google
6097
6460
  def update!(**args)
6098
6461
  @document_style = args[:document_style] if args.key?(:document_style)
6099
6462
  @fields = args[:fields] if args.key?(:fields)
6463
+ @tab_id = args[:tab_id] if args.key?(:tab_id)
6100
6464
  end
6101
6465
  end
6102
6466
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DocsV1
18
18
  # Version of the google-apis-docs_v1 gem
19
- GEM_VERSION = "0.27.0"
19
+ GEM_VERSION = "0.28.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.15.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230929"
25
+ REVISION = "20240722"
26
26
  end
27
27
  end
28
28
  end
@@ -58,6 +58,12 @@ module Google
58
58
  include Google::Apis::Core::JsonObjectSupport
59
59
  end
60
60
 
61
+ class BookmarkLink
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
61
67
  class Bullet
62
68
  class Representation < Google::Apis::Core::JsonRepresentation; end
63
69
 
@@ -220,6 +226,12 @@ module Google
220
226
  include Google::Apis::Core::JsonObjectSupport
221
227
  end
222
228
 
229
+ class DocumentTab
230
+ class Representation < Google::Apis::Core::JsonRepresentation; end
231
+
232
+ include Google::Apis::Core::JsonObjectSupport
233
+ end
234
+
223
235
  class EmbeddedDrawingProperties
224
236
  class Representation < Google::Apis::Core::JsonRepresentation; end
225
237
 
@@ -292,6 +304,12 @@ module Google
292
304
  include Google::Apis::Core::JsonObjectSupport
293
305
  end
294
306
 
307
+ class HeadingLink
308
+ class Representation < Google::Apis::Core::JsonRepresentation; end
309
+
310
+ include Google::Apis::Core::JsonObjectSupport
311
+ end
312
+
295
313
  class HorizontalRule
296
314
  class Representation < Google::Apis::Core::JsonRepresentation; end
297
315
 
@@ -766,6 +784,18 @@ module Google
766
784
  include Google::Apis::Core::JsonObjectSupport
767
785
  end
768
786
 
787
+ class Tab
788
+ class Representation < Google::Apis::Core::JsonRepresentation; end
789
+
790
+ include Google::Apis::Core::JsonObjectSupport
791
+ end
792
+
793
+ class TabProperties
794
+ class Representation < Google::Apis::Core::JsonRepresentation; end
795
+
796
+ include Google::Apis::Core::JsonObjectSupport
797
+ end
798
+
769
799
  class TabStop
770
800
  class Representation < Google::Apis::Core::JsonRepresentation; end
771
801
 
@@ -850,6 +880,12 @@ module Google
850
880
  include Google::Apis::Core::JsonObjectSupport
851
881
  end
852
882
 
883
+ class TabsCriteria
884
+ class Representation < Google::Apis::Core::JsonRepresentation; end
885
+
886
+ include Google::Apis::Core::JsonObjectSupport
887
+ end
888
+
853
889
  class TextRun
854
890
  class Representation < Google::Apis::Core::JsonRepresentation; end
855
891
 
@@ -985,6 +1021,14 @@ module Google
985
1021
  end
986
1022
  end
987
1023
 
1024
+ class BookmarkLink
1025
+ # @private
1026
+ class Representation < Google::Apis::Core::JsonRepresentation
1027
+ property :id, as: 'id'
1028
+ property :tab_id, as: 'tabId'
1029
+ end
1030
+ end
1031
+
988
1032
  class Bullet
989
1033
  # @private
990
1034
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1133,6 +1177,7 @@ module Google
1133
1177
  # @private
1134
1178
  class Representation < Google::Apis::Core::JsonRepresentation
1135
1179
  property :footer_id, as: 'footerId'
1180
+ property :tab_id, as: 'tabId'
1136
1181
  end
1137
1182
  end
1138
1183
 
@@ -1140,6 +1185,7 @@ module Google
1140
1185
  # @private
1141
1186
  class Representation < Google::Apis::Core::JsonRepresentation
1142
1187
  property :header_id, as: 'headerId'
1188
+ property :tab_id, as: 'tabId'
1143
1189
  end
1144
1190
  end
1145
1191
 
@@ -1148,6 +1194,8 @@ module Google
1148
1194
  class Representation < Google::Apis::Core::JsonRepresentation
1149
1195
  property :name, as: 'name'
1150
1196
  property :named_range_id, as: 'namedRangeId'
1197
+ property :tabs_criteria, as: 'tabsCriteria', class: Google::Apis::DocsV1::TabsCriteria, decorator: Google::Apis::DocsV1::TabsCriteria::Representation
1198
+
1151
1199
  end
1152
1200
  end
1153
1201
 
@@ -1163,6 +1211,7 @@ module Google
1163
1211
  # @private
1164
1212
  class Representation < Google::Apis::Core::JsonRepresentation
1165
1213
  property :object_id_prop, as: 'objectId'
1214
+ property :tab_id, as: 'tabId'
1166
1215
  end
1167
1216
  end
1168
1217
 
@@ -1220,6 +1269,8 @@ module Google
1220
1269
  hash :suggested_named_styles_changes, as: 'suggestedNamedStylesChanges', class: Google::Apis::DocsV1::SuggestedNamedStyles, decorator: Google::Apis::DocsV1::SuggestedNamedStyles::Representation
1221
1270
 
1222
1271
  property :suggestions_view_mode, as: 'suggestionsViewMode'
1272
+ collection :tabs, as: 'tabs', class: Google::Apis::DocsV1::Tab, decorator: Google::Apis::DocsV1::Tab::Representation
1273
+
1223
1274
  property :title, as: 'title'
1224
1275
  end
1225
1276
  end
@@ -1284,6 +1335,36 @@ module Google
1284
1335
  end
1285
1336
  end
1286
1337
 
1338
+ class DocumentTab
1339
+ # @private
1340
+ class Representation < Google::Apis::Core::JsonRepresentation
1341
+ property :body, as: 'body', class: Google::Apis::DocsV1::Body, decorator: Google::Apis::DocsV1::Body::Representation
1342
+
1343
+ property :document_style, as: 'documentStyle', class: Google::Apis::DocsV1::DocumentStyle, decorator: Google::Apis::DocsV1::DocumentStyle::Representation
1344
+
1345
+ hash :footers, as: 'footers', class: Google::Apis::DocsV1::Footer, decorator: Google::Apis::DocsV1::Footer::Representation
1346
+
1347
+ hash :footnotes, as: 'footnotes', class: Google::Apis::DocsV1::Footnote, decorator: Google::Apis::DocsV1::Footnote::Representation
1348
+
1349
+ hash :headers, as: 'headers', class: Google::Apis::DocsV1::Header, decorator: Google::Apis::DocsV1::Header::Representation
1350
+
1351
+ hash :inline_objects, as: 'inlineObjects', class: Google::Apis::DocsV1::InlineObject, decorator: Google::Apis::DocsV1::InlineObject::Representation
1352
+
1353
+ hash :lists, as: 'lists', class: Google::Apis::DocsV1::List, decorator: Google::Apis::DocsV1::List::Representation
1354
+
1355
+ hash :named_ranges, as: 'namedRanges', class: Google::Apis::DocsV1::NamedRanges, decorator: Google::Apis::DocsV1::NamedRanges::Representation
1356
+
1357
+ property :named_styles, as: 'namedStyles', class: Google::Apis::DocsV1::NamedStyles, decorator: Google::Apis::DocsV1::NamedStyles::Representation
1358
+
1359
+ hash :positioned_objects, as: 'positionedObjects', class: Google::Apis::DocsV1::PositionedObject, decorator: Google::Apis::DocsV1::PositionedObject::Representation
1360
+
1361
+ hash :suggested_document_style_changes, as: 'suggestedDocumentStyleChanges', class: Google::Apis::DocsV1::SuggestedDocumentStyle, decorator: Google::Apis::DocsV1::SuggestedDocumentStyle::Representation
1362
+
1363
+ hash :suggested_named_styles_changes, as: 'suggestedNamedStylesChanges', class: Google::Apis::DocsV1::SuggestedNamedStyles, decorator: Google::Apis::DocsV1::SuggestedNamedStyles::Representation
1364
+
1365
+ end
1366
+ end
1367
+
1287
1368
  class EmbeddedDrawingProperties
1288
1369
  # @private
1289
1370
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1370,6 +1451,7 @@ module Google
1370
1451
  # @private
1371
1452
  class Representation < Google::Apis::Core::JsonRepresentation
1372
1453
  property :segment_id, as: 'segmentId'
1454
+ property :tab_id, as: 'tabId'
1373
1455
  end
1374
1456
  end
1375
1457
 
@@ -1422,6 +1504,14 @@ module Google
1422
1504
  end
1423
1505
  end
1424
1506
 
1507
+ class HeadingLink
1508
+ # @private
1509
+ class Representation < Google::Apis::Core::JsonRepresentation
1510
+ property :id, as: 'id'
1511
+ property :tab_id, as: 'tabId'
1512
+ end
1513
+ end
1514
+
1425
1515
  class HorizontalRule
1426
1516
  # @private
1427
1517
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1596,8 +1686,13 @@ module Google
1596
1686
  class Link
1597
1687
  # @private
1598
1688
  class Representation < Google::Apis::Core::JsonRepresentation
1689
+ property :bookmark, as: 'bookmark', class: Google::Apis::DocsV1::BookmarkLink, decorator: Google::Apis::DocsV1::BookmarkLink::Representation
1690
+
1599
1691
  property :bookmark_id, as: 'bookmarkId'
1692
+ property :heading, as: 'heading', class: Google::Apis::DocsV1::HeadingLink, decorator: Google::Apis::DocsV1::HeadingLink::Representation
1693
+
1600
1694
  property :heading_id, as: 'headingId'
1695
+ property :tab_id, as: 'tabId'
1601
1696
  property :url, as: 'url'
1602
1697
  end
1603
1698
  end
@@ -1651,6 +1746,7 @@ module Google
1651
1746
  class Representation < Google::Apis::Core::JsonRepresentation
1652
1747
  property :index, as: 'index'
1653
1748
  property :segment_id, as: 'segmentId'
1749
+ property :tab_id, as: 'tabId'
1654
1750
  end
1655
1751
  end
1656
1752
 
@@ -1997,6 +2093,7 @@ module Google
1997
2093
  property :end_index, as: 'endIndex'
1998
2094
  property :segment_id, as: 'segmentId'
1999
2095
  property :start_index, as: 'startIndex'
2096
+ property :tab_id, as: 'tabId'
2000
2097
  end
2001
2098
  end
2002
2099
 
@@ -2006,6 +2103,8 @@ module Google
2006
2103
  property :contains_text, as: 'containsText', class: Google::Apis::DocsV1::SubstringMatchCriteria, decorator: Google::Apis::DocsV1::SubstringMatchCriteria::Representation
2007
2104
 
2008
2105
  property :replace_text, as: 'replaceText'
2106
+ property :tabs_criteria, as: 'tabsCriteria', class: Google::Apis::DocsV1::TabsCriteria, decorator: Google::Apis::DocsV1::TabsCriteria::Representation
2107
+
2009
2108
  end
2010
2109
  end
2011
2110
 
@@ -2021,6 +2120,7 @@ module Google
2021
2120
  class Representation < Google::Apis::Core::JsonRepresentation
2022
2121
  property :image_object_id, as: 'imageObjectId'
2023
2122
  property :image_replace_method, as: 'imageReplaceMethod'
2123
+ property :tab_id, as: 'tabId'
2024
2124
  property :uri, as: 'uri'
2025
2125
  end
2026
2126
  end
@@ -2030,6 +2130,8 @@ module Google
2030
2130
  class Representation < Google::Apis::Core::JsonRepresentation
2031
2131
  property :named_range_id, as: 'namedRangeId'
2032
2132
  property :named_range_name, as: 'namedRangeName'
2133
+ property :tabs_criteria, as: 'tabsCriteria', class: Google::Apis::DocsV1::TabsCriteria, decorator: Google::Apis::DocsV1::TabsCriteria::Representation
2134
+
2033
2135
  property :text, as: 'text'
2034
2136
  end
2035
2137
  end
@@ -2384,6 +2486,29 @@ module Google
2384
2486
  end
2385
2487
  end
2386
2488
 
2489
+ class Tab
2490
+ # @private
2491
+ class Representation < Google::Apis::Core::JsonRepresentation
2492
+ collection :child_tabs, as: 'childTabs', class: Google::Apis::DocsV1::Tab, decorator: Google::Apis::DocsV1::Tab::Representation
2493
+
2494
+ property :document_tab, as: 'documentTab', class: Google::Apis::DocsV1::DocumentTab, decorator: Google::Apis::DocsV1::DocumentTab::Representation
2495
+
2496
+ property :tab_properties, as: 'tabProperties', class: Google::Apis::DocsV1::TabProperties, decorator: Google::Apis::DocsV1::TabProperties::Representation
2497
+
2498
+ end
2499
+ end
2500
+
2501
+ class TabProperties
2502
+ # @private
2503
+ class Representation < Google::Apis::Core::JsonRepresentation
2504
+ property :index, as: 'index'
2505
+ property :nesting_level, as: 'nestingLevel'
2506
+ property :parent_tab_id, as: 'parentTabId'
2507
+ property :tab_id, as: 'tabId'
2508
+ property :title, as: 'title'
2509
+ end
2510
+ end
2511
+
2387
2512
  class TabStop
2388
2513
  # @private
2389
2514
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2559,6 +2684,13 @@ module Google
2559
2684
  end
2560
2685
  end
2561
2686
 
2687
+ class TabsCriteria
2688
+ # @private
2689
+ class Representation < Google::Apis::Core::JsonRepresentation
2690
+ collection :tab_ids, as: 'tabIds'
2691
+ end
2692
+ end
2693
+
2562
2694
  class TextRun
2563
2695
  # @private
2564
2696
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2625,6 +2757,7 @@ module Google
2625
2757
  property :document_style, as: 'documentStyle', class: Google::Apis::DocsV1::DocumentStyle, decorator: Google::Apis::DocsV1::DocumentStyle::Representation
2626
2758
 
2627
2759
  property :fields, as: 'fields'
2760
+ property :tab_id, as: 'tabId'
2628
2761
  end
2629
2762
  end
2630
2763
 
@@ -131,6 +131,14 @@ module Google
131
131
  # Gets the latest version of the specified document.
132
132
  # @param [String] document_id
133
133
  # The ID of the document to retrieve.
134
+ # @param [Boolean] include_tabs_content
135
+ # Whether to populate the Document.tabs field instead of the text content fields
136
+ # like body and documentStyle on Document. - When `True`: Document content
137
+ # populates in the Document.tabs field instead of the text content fields in
138
+ # Document. - When `False`: The content of the document's first tab populates
139
+ # the content fields in Document excluding Document.tabs. If a document has only
140
+ # one tab, then that tab is used to populate the document content. Document.tabs
141
+ # will be empty.
134
142
  # @param [String] suggestions_view_mode
135
143
  # The suggestions view mode to apply to the document. This allows viewing the
136
144
  # document with all suggestions inline, accepted or rejected. If one is not
@@ -152,11 +160,12 @@ module Google
152
160
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
153
161
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
154
162
  # @raise [Google::Apis::AuthorizationError] Authorization is required
155
- def get_document(document_id, suggestions_view_mode: nil, fields: nil, quota_user: nil, options: nil, &block)
163
+ def get_document(document_id, include_tabs_content: nil, suggestions_view_mode: nil, fields: nil, quota_user: nil, options: nil, &block)
156
164
  command = make_simple_command(:get, 'v1/documents/{documentId}', options)
157
165
  command.response_representation = Google::Apis::DocsV1::Document::Representation
158
166
  command.response_class = Google::Apis::DocsV1::Document
159
167
  command.params['documentId'] = document_id unless document_id.nil?
168
+ command.query['includeTabsContent'] = include_tabs_content unless include_tabs_content.nil?
160
169
  command.query['suggestionsViewMode'] = suggestions_view_mode unless suggestions_view_mode.nil?
161
170
  command.query['fields'] = fields unless fields.nil?
162
171
  command.query['quotaUser'] = quota_user unless quota_user.nil?
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-docs_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.27.0
4
+ version: 0.28.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-05-19 00:00:00.000000000 Z
11
+ date: 2024-07-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-docs_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-docs_v1/v0.27.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-docs_v1/v0.28.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-docs_v1
63
63
  post_install_message:
64
64
  rdoc_options: []