google-apis-docs_v1 0.46.0 → 0.48.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.
@@ -22,6 +22,81 @@ module Google
22
22
  module Apis
23
23
  module DocsV1
24
24
 
25
+ # Accepts a suggestion. Returns a 403 forbidden error if the requesting user
26
+ # does not have edit access to the document. [Developer Preview](https://
27
+ # developers.google.com/workspace/preview).
28
+ class AcceptSuggestionRequest
29
+ include Google::Apis::Core::Hashable
30
+
31
+ # The ID of the suggestion.
32
+ # Corresponds to the JSON property `suggestionId`
33
+ # @return [String]
34
+ attr_accessor :suggestion_id
35
+
36
+ def initialize(**args)
37
+ update!(**args)
38
+ end
39
+
40
+ # Update properties of this object
41
+ def update!(**args)
42
+ @suggestion_id = args[:suggestion_id] if args.key?(:suggestion_id)
43
+ end
44
+ end
45
+
46
+ # Inserts a reply Post into a CommentThread or SuggestionThread. [Developer
47
+ # Preview](https://developers.google.com/workspace/preview).
48
+ class AddCommentReplyRequest
49
+ include Google::Apis::Core::Hashable
50
+
51
+ # The ID of the CommentThread to add the reply to.
52
+ # Corresponds to the JSON property `commentId`
53
+ # @return [String]
54
+ attr_accessor :comment_id
55
+
56
+ # Represents a single post in a comment or suggestion thread. [Developer Preview]
57
+ # (https://developers.google.com/workspace/preview).
58
+ # Corresponds to the JSON property `post`
59
+ # @return [Google::Apis::DocsV1::Post]
60
+ attr_accessor :post
61
+
62
+ # The ID of the SuggestionThread to add the reply to.
63
+ # Corresponds to the JSON property `suggestionId`
64
+ # @return [String]
65
+ attr_accessor :suggestion_id
66
+
67
+ def initialize(**args)
68
+ update!(**args)
69
+ end
70
+
71
+ # Update properties of this object
72
+ def update!(**args)
73
+ @comment_id = args[:comment_id] if args.key?(:comment_id)
74
+ @post = args[:post] if args.key?(:post)
75
+ @suggestion_id = args[:suggestion_id] if args.key?(:suggestion_id)
76
+ end
77
+ end
78
+
79
+ # Response message for adding a reply. [Developer Preview](https://developers.
80
+ # google.com/workspace/preview).
81
+ class AddCommentReplyResponse
82
+ include Google::Apis::Core::Hashable
83
+
84
+ # Represents a single post in a comment or suggestion thread. [Developer Preview]
85
+ # (https://developers.google.com/workspace/preview).
86
+ # Corresponds to the JSON property `post`
87
+ # @return [Google::Apis::DocsV1::Post]
88
+ attr_accessor :post
89
+
90
+ def initialize(**args)
91
+ update!(**args)
92
+ end
93
+
94
+ # Update properties of this object
95
+ def update!(**args)
96
+ @post = args[:post] if args.key?(:post)
97
+ end
98
+ end
99
+
25
100
  # Adds a document tab. When a tab is added at a given index, all subsequent tabs'
26
101
  # indexes are incremented.
27
102
  class AddDocumentTabRequest
@@ -187,6 +262,12 @@ module Google
187
262
  class BatchUpdateDocumentResponse
188
263
  include Google::Apis::Core::Hashable
189
264
 
265
+ # Whether comment updates were applied in the batch request. [Developer Preview](
266
+ # https://developers.google.com/workspace/preview).
267
+ # Corresponds to the JSON property `commentUpdateState`
268
+ # @return [String]
269
+ attr_accessor :comment_update_state
270
+
190
271
  # The ID of the document to which the updates were applied to.
191
272
  # Corresponds to the JSON property `documentId`
192
273
  # @return [String]
@@ -198,6 +279,12 @@ module Google
198
279
  # @return [Array<Google::Apis::DocsV1::Response>]
199
280
  attr_accessor :replies
200
281
 
282
+ # The suggestions which were affected by each update. This maps 1:1 with the
283
+ # updates. [Developer Preview](https://developers.google.com/workspace/preview).
284
+ # Corresponds to the JSON property `suggestionResponses`
285
+ # @return [Array<Google::Apis::DocsV1::SuggestionResponse>]
286
+ attr_accessor :suggestion_responses
287
+
201
288
  # Provides control over how write requests are executed.
202
289
  # Corresponds to the JSON property `writeControl`
203
290
  # @return [Google::Apis::DocsV1::WriteControl]
@@ -209,8 +296,10 @@ module Google
209
296
 
210
297
  # Update properties of this object
211
298
  def update!(**args)
299
+ @comment_update_state = args[:comment_update_state] if args.key?(:comment_update_state)
212
300
  @document_id = args[:document_id] if args.key?(:document_id)
213
301
  @replies = args[:replies] if args.key?(:replies)
302
+ @suggestion_responses = args[:suggestion_responses] if args.key?(:suggestion_responses)
214
303
  @write_control = args[:write_control] if args.key?(:write_control)
215
304
  end
216
305
  end
@@ -405,6 +494,86 @@ module Google
405
494
  end
406
495
  end
407
496
 
497
+ # One or more locations in the document that are tied to CommentThreads with the
498
+ # same anchorId. Note: Multiple anchors may refer to the same location. [
499
+ # Developer Preview](https://developers.google.com/workspace/preview).
500
+ class CommentAnchor
501
+ include Google::Apis::Core::Hashable
502
+
503
+ # The ID of the comment anchor.
504
+ # Corresponds to the JSON property `anchorId`
505
+ # @return [String]
506
+ attr_accessor :anchor_id
507
+
508
+ # A collection of Ranges in the document which are tied to this anchor.
509
+ # Corresponds to the JSON property `ranges`
510
+ # @return [Array<Google::Apis::DocsV1::Range>]
511
+ attr_accessor :ranges
512
+
513
+ def initialize(**args)
514
+ update!(**args)
515
+ end
516
+
517
+ # Update properties of this object
518
+ def update!(**args)
519
+ @anchor_id = args[:anchor_id] if args.key?(:anchor_id)
520
+ @ranges = args[:ranges] if args.key?(:ranges)
521
+ end
522
+ end
523
+
524
+ # Represents a single comment thread. [Developer Preview](https://developers.
525
+ # google.com/workspace/preview).
526
+ class CommentThread
527
+ include Google::Apis::Core::Hashable
528
+
529
+ # The ID of the CommentAnchor in the document that this thread is tied to.
530
+ # Multiple comment threads may be anchored to the same CommentAnchor.
531
+ # Corresponds to the JSON property `anchorId`
532
+ # @return [String]
533
+ attr_accessor :anchor_id
534
+
535
+ # The unique ID of the comment thread.
536
+ # Corresponds to the JSON property `commentId`
537
+ # @return [String]
538
+ attr_accessor :comment_id
539
+
540
+ # Represents a single post in a comment or suggestion thread. [Developer Preview]
541
+ # (https://developers.google.com/workspace/preview).
542
+ # Corresponds to the JSON property `headPost`
543
+ # @return [Google::Apis::DocsV1::Post]
544
+ attr_accessor :head_post
545
+
546
+ # The quoted text from the document when the comment was created, formatted as
547
+ # plain-text.
548
+ # Corresponds to the JSON property `plainTextQuote`
549
+ # @return [String]
550
+ attr_accessor :plain_text_quote
551
+
552
+ # Replies to the head post.
553
+ # Corresponds to the JSON property `replies`
554
+ # @return [Array<Google::Apis::DocsV1::Post>]
555
+ attr_accessor :replies
556
+
557
+ # Whether the thread is open or resolved.
558
+ # Corresponds to the JSON property `status`
559
+ # @return [String]
560
+ attr_accessor :status
561
+
562
+ def initialize(**args)
563
+ update!(**args)
564
+ end
565
+
566
+ # Update properties of this object
567
+ def update!(**args)
568
+ @anchor_id = args[:anchor_id] if args.key?(:anchor_id)
569
+ @comment_id = args[:comment_id] if args.key?(:comment_id)
570
+ @head_post = args[:head_post] if args.key?(:head_post)
571
+ @plain_text_quote = args[:plain_text_quote] if args.key?(:plain_text_quote)
572
+ @replies = args[:replies] if args.key?(:replies)
573
+ @status = args[:status] if args.key?(:status)
574
+ end
575
+ end
576
+
408
577
  # Creates a Footer. The new footer is applied to the SectionStyle at the
409
578
  # location of the SectionBreak if specified, otherwise it is applied to the
410
579
  # DocumentStyle. If a footer of the specified type already exists, a 400 bad
@@ -921,6 +1090,61 @@ module Google
921
1090
  end
922
1091
  end
923
1092
 
1093
+ # Deletes a reply Post from a CommentThread or SuggestionThread. Returns a 400
1094
+ # bad request error if: - The requesting user is not the author of the post. -
1095
+ # The reply post contains an action. - The reply post contains an assignee. [
1096
+ # Developer Preview](https://developers.google.com/workspace/preview).
1097
+ class DeleteCommentReplyRequest
1098
+ include Google::Apis::Core::Hashable
1099
+
1100
+ # The ID of the CommentThread which the post belongs to.
1101
+ # Corresponds to the JSON property `commentId`
1102
+ # @return [String]
1103
+ attr_accessor :comment_id
1104
+
1105
+ # The ID of the reply Post being deleted.
1106
+ # Corresponds to the JSON property `postId`
1107
+ # @return [String]
1108
+ attr_accessor :post_id
1109
+
1110
+ # The ID of the SuggestionThread which the post belongs to.
1111
+ # Corresponds to the JSON property `suggestionId`
1112
+ # @return [String]
1113
+ attr_accessor :suggestion_id
1114
+
1115
+ def initialize(**args)
1116
+ update!(**args)
1117
+ end
1118
+
1119
+ # Update properties of this object
1120
+ def update!(**args)
1121
+ @comment_id = args[:comment_id] if args.key?(:comment_id)
1122
+ @post_id = args[:post_id] if args.key?(:post_id)
1123
+ @suggestion_id = args[:suggestion_id] if args.key?(:suggestion_id)
1124
+ end
1125
+ end
1126
+
1127
+ # Deletes a CommentThread. Returns a 400 bad request error if the requesting
1128
+ # user is not the author of the headPost. [Developer Preview](https://developers.
1129
+ # google.com/workspace/preview).
1130
+ class DeleteCommentRequest
1131
+ include Google::Apis::Core::Hashable
1132
+
1133
+ # The ID of the CommentThread that is being deleted.
1134
+ # Corresponds to the JSON property `commentId`
1135
+ # @return [String]
1136
+ attr_accessor :comment_id
1137
+
1138
+ def initialize(**args)
1139
+ update!(**args)
1140
+ end
1141
+
1142
+ # Update properties of this object
1143
+ def update!(**args)
1144
+ @comment_id = args[:comment_id] if args.key?(:comment_id)
1145
+ end
1146
+ end
1147
+
924
1148
  # Deletes content from the document.
925
1149
  class DeleteContentRangeRequest
926
1150
  include Google::Apis::Core::Hashable
@@ -1091,6 +1315,27 @@ module Google
1091
1315
  end
1092
1316
  end
1093
1317
 
1318
+ # Deletes a suggestion. Returns a 403 forbidden error if the requesting user is
1319
+ # not the author of the suggestion. [Developer Preview](https://developers.
1320
+ # google.com/workspace/preview).
1321
+ class DeleteSuggestionRequest
1322
+ include Google::Apis::Core::Hashable
1323
+
1324
+ # The ID of the suggestion.
1325
+ # Corresponds to the JSON property `suggestionId`
1326
+ # @return [String]
1327
+ attr_accessor :suggestion_id
1328
+
1329
+ def initialize(**args)
1330
+ update!(**args)
1331
+ end
1332
+
1333
+ # Update properties of this object
1334
+ def update!(**args)
1335
+ @suggestion_id = args[:suggestion_id] if args.key?(:suggestion_id)
1336
+ end
1337
+ end
1338
+
1094
1339
  # Deletes a tab. If the tab has child tabs, they are deleted as well.
1095
1340
  class DeleteTabRequest
1096
1341
  include Google::Apis::Core::Hashable
@@ -1183,6 +1428,20 @@ module Google
1183
1428
  # @return [Google::Apis::DocsV1::Body]
1184
1429
  attr_accessor :body
1185
1430
 
1431
+ # Output only. The comments associated with the document. Only populated if the
1432
+ # commentsViewMode parameter is set to require comments (such as `
1433
+ # COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.
1434
+ # com/workspace/preview).
1435
+ # Corresponds to the JSON property `comments`
1436
+ # @return [Array<Google::Apis::DocsV1::CommentThread>]
1437
+ attr_accessor :comments
1438
+
1439
+ # Output only. The comments view mode applied to the document. [Developer
1440
+ # Preview](https://developers.google.com/workspace/preview).
1441
+ # Corresponds to the JSON property `commentsViewMode`
1442
+ # @return [String]
1443
+ attr_accessor :comments_view_mode
1444
+
1186
1445
  # Output only. The ID of the document.
1187
1446
  # Corresponds to the JSON property `documentId`
1188
1447
  # @return [String]
@@ -1295,6 +1554,14 @@ module Google
1295
1554
  # @return [Hash<String,Google::Apis::DocsV1::SuggestedNamedStyles>]
1296
1555
  attr_accessor :suggested_named_styles_changes
1297
1556
 
1557
+ # Output only. The suggestions associated with the document. Only populated if
1558
+ # the commentsViewMode parameter is set to require comments (such as `
1559
+ # COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.
1560
+ # com/workspace/preview).
1561
+ # Corresponds to the JSON property `suggestions`
1562
+ # @return [Array<Google::Apis::DocsV1::SuggestionThread>]
1563
+ attr_accessor :suggestions
1564
+
1298
1565
  # Output only. The suggestions view mode applied to the document. Note: When
1299
1566
  # editing a document, changes must be based on a document with
1300
1567
  # SUGGESTIONS_INLINE.
@@ -1302,8 +1569,9 @@ module Google
1302
1569
  # @return [String]
1303
1570
  attr_accessor :suggestions_view_mode
1304
1571
 
1305
- # Tabs that are part of a document. Tabs can contain child tabs, a tab nested
1306
- # within another tab. Child tabs are represented by the Tab.childTabs field.
1572
+ # Output only. Tabs that are part of a document. Tabs can contain child tabs, a
1573
+ # tab nested within another tab. Child tabs are represented by the Tab.childTabs
1574
+ # field.
1307
1575
  # Corresponds to the JSON property `tabs`
1308
1576
  # @return [Array<Google::Apis::DocsV1::Tab>]
1309
1577
  attr_accessor :tabs
@@ -1320,6 +1588,8 @@ module Google
1320
1588
  # Update properties of this object
1321
1589
  def update!(**args)
1322
1590
  @body = args[:body] if args.key?(:body)
1591
+ @comments = args[:comments] if args.key?(:comments)
1592
+ @comments_view_mode = args[:comments_view_mode] if args.key?(:comments_view_mode)
1323
1593
  @document_id = args[:document_id] if args.key?(:document_id)
1324
1594
  @document_style = args[:document_style] if args.key?(:document_style)
1325
1595
  @footers = args[:footers] if args.key?(:footers)
@@ -1333,6 +1603,7 @@ module Google
1333
1603
  @revision_id = args[:revision_id] if args.key?(:revision_id)
1334
1604
  @suggested_document_style_changes = args[:suggested_document_style_changes] if args.key?(:suggested_document_style_changes)
1335
1605
  @suggested_named_styles_changes = args[:suggested_named_styles_changes] if args.key?(:suggested_named_styles_changes)
1606
+ @suggestions = args[:suggestions] if args.key?(:suggestions)
1336
1607
  @suggestions_view_mode = args[:suggestions_view_mode] if args.key?(:suggestions_view_mode)
1337
1608
  @tabs = args[:tabs] if args.key?(:tabs)
1338
1609
  @title = args[:title] if args.key?(:title)
@@ -1686,6 +1957,14 @@ module Google
1686
1957
  # @return [Google::Apis::DocsV1::Body]
1687
1958
  attr_accessor :body
1688
1959
 
1960
+ # The comment anchors in a document tab, keyed by anchor ID. Only populated if
1961
+ # the commentsViewMode parameter is set to require comments (such as `
1962
+ # COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.
1963
+ # com/workspace/preview).
1964
+ # Corresponds to the JSON property `commentAnchors`
1965
+ # @return [Hash<String,Google::Apis::DocsV1::CommentAnchor>]
1966
+ attr_accessor :comment_anchors
1967
+
1689
1968
  # The style of the document.
1690
1969
  # Corresponds to the JSON property `documentStyle`
1691
1970
  # @return [Google::Apis::DocsV1::DocumentStyle]
@@ -1750,6 +2029,7 @@ module Google
1750
2029
  # Update properties of this object
1751
2030
  def update!(**args)
1752
2031
  @body = args[:body] if args.key?(:body)
2032
+ @comment_anchors = args[:comment_anchors] if args.key?(:comment_anchors)
1753
2033
  @document_style = args[:document_style] if args.key?(:document_style)
1754
2034
  @footers = args[:footers] if args.key?(:footers)
1755
2035
  @footnotes = args[:footnotes] if args.key?(:footnotes)
@@ -2602,6 +2882,63 @@ module Google
2602
2882
  end
2603
2883
  end
2604
2884
 
2885
+ # Inserts a CommentThread into the document. [Developer Preview](https://
2886
+ # developers.google.com/workspace/preview).
2887
+ class InsertCommentRequest
2888
+ include Google::Apis::Core::Hashable
2889
+
2890
+ # Optional. The email address of the assignee of the comment. Leave empty for a
2891
+ # non-assigned comment. May not exceed 2048 UTF-8 code units.
2892
+ # Corresponds to the JSON property `assigneeEmailAddress`
2893
+ # @return [String]
2894
+ attr_accessor :assignee_email_address
2895
+
2896
+ # The text of the comment, as plain text. This text content will be handled
2897
+ # similarly to comments created in the Docs editor. It will have similar
2898
+ # behaviors for formatting, notifications, etc. This field cannot be empty, and
2899
+ # must not exceed 2048 UTF-8 code units.
2900
+ # Corresponds to the JSON property `content`
2901
+ # @return [String]
2902
+ attr_accessor :content
2903
+
2904
+ # Specifies a contiguous range of text.
2905
+ # Corresponds to the JSON property `range`
2906
+ # @return [Google::Apis::DocsV1::Range]
2907
+ attr_accessor :range
2908
+
2909
+ def initialize(**args)
2910
+ update!(**args)
2911
+ end
2912
+
2913
+ # Update properties of this object
2914
+ def update!(**args)
2915
+ @assignee_email_address = args[:assignee_email_address] if args.key?(:assignee_email_address)
2916
+ @content = args[:content] if args.key?(:content)
2917
+ @range = args[:range] if args.key?(:range)
2918
+ end
2919
+ end
2920
+
2921
+ # Response message for inserting a comment. [Developer Preview](https://
2922
+ # developers.google.com/workspace/preview).
2923
+ class InsertCommentResponse
2924
+ include Google::Apis::Core::Hashable
2925
+
2926
+ # Represents a single comment thread. [Developer Preview](https://developers.
2927
+ # google.com/workspace/preview).
2928
+ # Corresponds to the JSON property `commentThread`
2929
+ # @return [Google::Apis::DocsV1::CommentThread]
2930
+ attr_accessor :comment_thread
2931
+
2932
+ def initialize(**args)
2933
+ update!(**args)
2934
+ end
2935
+
2936
+ # Update properties of this object
2937
+ def update!(**args)
2938
+ @comment_thread = args[:comment_thread] if args.key?(:comment_thread)
2939
+ end
2940
+ end
2941
+
2605
2942
  # Inserts a date at the specified location.
2606
2943
  class InsertDateRequest
2607
2944
  include Google::Apis::Core::Hashable
@@ -4506,6 +4843,157 @@ module Google
4506
4843
  end
4507
4844
  end
4508
4845
 
4846
+ # Represents a single post in a comment or suggestion thread. [Developer Preview]
4847
+ # (https://developers.google.com/workspace/preview).
4848
+ class Post
4849
+ include Google::Apis::Core::Hashable
4850
+
4851
+ # Optional. The email of the user who is being newly assigned to the thread as
4852
+ # part of this post. Returns a 400 bad request error if: - The parent thread is
4853
+ # a CommentThread whose headPost does not have an assignee. - The parent thread
4854
+ # is a SuggestionThread. - commentAction is specified as `RESOLVE` or `REOPEN`. -
4855
+ # `assigneeEmail` exceeds 2048 UTF-8 code units.
4856
+ # Corresponds to the JSON property `assigneeEmail`
4857
+ # @return [String]
4858
+ attr_accessor :assignee_email
4859
+
4860
+ # Represents a user who authored a comment or suggestion post. [Developer
4861
+ # Preview](https://developers.google.com/workspace/preview).
4862
+ # Corresponds to the JSON property `author`
4863
+ # @return [Google::Apis::DocsV1::PostAuthor]
4864
+ attr_accessor :author
4865
+
4866
+ # Optional. The action type for comment posts.
4867
+ # Corresponds to the JSON property `commentAction`
4868
+ # @return [String]
4869
+ attr_accessor :comment_action
4870
+
4871
+ # The content of the post. Required to be non-empty if commentAction is not `
4872
+ # RESOLVE` or `REOPEN`. This text content will be handled similarly to comments
4873
+ # created in the Docs editor. It will have similar behaviors for formatting,
4874
+ # notifications, etc. May not exceed 2048 UTF-8 code units.
4875
+ # Corresponds to the JSON property `content`
4876
+ # @return [String]
4877
+ attr_accessor :content
4878
+
4879
+ # Output only. The content of the post as HTML.
4880
+ # Corresponds to the JSON property `contentHtml`
4881
+ # @return [String]
4882
+ attr_accessor :content_html
4883
+
4884
+ # Output only. The time the post was created.
4885
+ # Corresponds to the JSON property `createTime`
4886
+ # @return [String]
4887
+ attr_accessor :create_time
4888
+
4889
+ # Output only. Whether the post is deleted. If `true`, content and author fields
4890
+ # will be empty.
4891
+ # Corresponds to the JSON property `deleted`
4892
+ # @return [Boolean]
4893
+ attr_accessor :deleted
4894
+ alias_method :deleted?, :deleted
4895
+
4896
+ # Output only. Whether the post is from a copied document. This field cannot be
4897
+ # set directly by callers.
4898
+ # Corresponds to the JSON property `fromCopiedDocument`
4899
+ # @return [Boolean]
4900
+ attr_accessor :from_copied_document
4901
+ alias_method :from_copied_document?, :from_copied_document
4902
+
4903
+ # Output only. Whether the post is from a document comparison. This field cannot
4904
+ # be set directly by callers.
4905
+ # Corresponds to the JSON property `fromDocumentComparison`
4906
+ # @return [Boolean]
4907
+ attr_accessor :from_document_comparison
4908
+ alias_method :from_document_comparison?, :from_document_comparison
4909
+
4910
+ # Output only. Whether the post is from an imported document. This field cannot
4911
+ # be set directly by callers.
4912
+ # Corresponds to the JSON property `fromImportedDocument`
4913
+ # @return [Boolean]
4914
+ attr_accessor :from_imported_document
4915
+ alias_method :from_imported_document?, :from_imported_document
4916
+
4917
+ # Output only. The unique ID of the post.
4918
+ # Corresponds to the JSON property `postId`
4919
+ # @return [String]
4920
+ attr_accessor :post_id
4921
+
4922
+ # Output only. The action type for suggestion posts.
4923
+ # Corresponds to the JSON property `suggestionAction`
4924
+ # @return [String]
4925
+ attr_accessor :suggestion_action
4926
+
4927
+ # Output only. The time the post was last updated.
4928
+ # Corresponds to the JSON property `updateTime`
4929
+ # @return [String]
4930
+ attr_accessor :update_time
4931
+
4932
+ def initialize(**args)
4933
+ update!(**args)
4934
+ end
4935
+
4936
+ # Update properties of this object
4937
+ def update!(**args)
4938
+ @assignee_email = args[:assignee_email] if args.key?(:assignee_email)
4939
+ @author = args[:author] if args.key?(:author)
4940
+ @comment_action = args[:comment_action] if args.key?(:comment_action)
4941
+ @content = args[:content] if args.key?(:content)
4942
+ @content_html = args[:content_html] if args.key?(:content_html)
4943
+ @create_time = args[:create_time] if args.key?(:create_time)
4944
+ @deleted = args[:deleted] if args.key?(:deleted)
4945
+ @from_copied_document = args[:from_copied_document] if args.key?(:from_copied_document)
4946
+ @from_document_comparison = args[:from_document_comparison] if args.key?(:from_document_comparison)
4947
+ @from_imported_document = args[:from_imported_document] if args.key?(:from_imported_document)
4948
+ @post_id = args[:post_id] if args.key?(:post_id)
4949
+ @suggestion_action = args[:suggestion_action] if args.key?(:suggestion_action)
4950
+ @update_time = args[:update_time] if args.key?(:update_time)
4951
+ end
4952
+ end
4953
+
4954
+ # Represents a user who authored a comment or suggestion post. [Developer
4955
+ # Preview](https://developers.google.com/workspace/preview).
4956
+ class PostAuthor
4957
+ include Google::Apis::Core::Hashable
4958
+
4959
+ # Whether the user is anonymous.
4960
+ # Corresponds to the JSON property `anonymous`
4961
+ # @return [Boolean]
4962
+ attr_accessor :anonymous
4963
+ alias_method :anonymous?, :anonymous
4964
+
4965
+ # The display name of the user. May be absent if the author is anonymous.
4966
+ # Corresponds to the JSON property `displayName`
4967
+ # @return [String]
4968
+ attr_accessor :display_name
4969
+
4970
+ # Whether the user is the authenticated user making the request.
4971
+ # Corresponds to the JSON property `me`
4972
+ # @return [Boolean]
4973
+ attr_accessor :me
4974
+ alias_method :me?, :me
4975
+
4976
+ # The resource name of the post author user, which can also be used to identify
4977
+ # the user in the [Google People API](https://developers.google.com/people/api/
4978
+ # rest/v1/people). Format: `users/`user``. Will not be populated if the
4979
+ # anonymous field is `true` or if the post is from an imported document.
4980
+ # Corresponds to the JSON property `user`
4981
+ # @return [String]
4982
+ attr_accessor :user
4983
+
4984
+ def initialize(**args)
4985
+ update!(**args)
4986
+ end
4987
+
4988
+ # Update properties of this object
4989
+ def update!(**args)
4990
+ @anonymous = args[:anonymous] if args.key?(:anonymous)
4991
+ @display_name = args[:display_name] if args.key?(:display_name)
4992
+ @me = args[:me] if args.key?(:me)
4993
+ @user = args[:user] if args.key?(:user)
4994
+ end
4995
+ end
4996
+
4509
4997
  # Specifies a contiguous range of text.
4510
4998
  class Range
4511
4999
  include Google::Apis::Core::Hashable
@@ -4553,6 +5041,28 @@ module Google
4553
5041
  end
4554
5042
  end
4555
5043
 
5044
+ # Rejects a suggestion. Returns a 403 forbidden error if the requesting user
5045
+ # does not have edit access to the document and is not the author of the
5046
+ # suggestion. [Developer Preview](https://developers.google.com/workspace/
5047
+ # preview).
5048
+ class RejectSuggestionRequest
5049
+ include Google::Apis::Core::Hashable
5050
+
5051
+ # The ID of the suggestion.
5052
+ # Corresponds to the JSON property `suggestionId`
5053
+ # @return [String]
5054
+ attr_accessor :suggestion_id
5055
+
5056
+ def initialize(**args)
5057
+ update!(**args)
5058
+ end
5059
+
5060
+ # Update properties of this object
5061
+ def update!(**args)
5062
+ @suggestion_id = args[:suggestion_id] if args.key?(:suggestion_id)
5063
+ end
5064
+ end
5065
+
4556
5066
  # Replaces all instances of text matching a criteria with replace text.
4557
5067
  class ReplaceAllTextRequest
4558
5068
  include Google::Apis::Core::Hashable
@@ -4702,6 +5212,19 @@ module Google
4702
5212
  class Request
4703
5213
  include Google::Apis::Core::Hashable
4704
5214
 
5215
+ # Accepts a suggestion. Returns a 403 forbidden error if the requesting user
5216
+ # does not have edit access to the document. [Developer Preview](https://
5217
+ # developers.google.com/workspace/preview).
5218
+ # Corresponds to the JSON property `acceptSuggestion`
5219
+ # @return [Google::Apis::DocsV1::AcceptSuggestionRequest]
5220
+ attr_accessor :accept_suggestion
5221
+
5222
+ # Inserts a reply Post into a CommentThread or SuggestionThread. [Developer
5223
+ # Preview](https://developers.google.com/workspace/preview).
5224
+ # Corresponds to the JSON property `addCommentReply`
5225
+ # @return [Google::Apis::DocsV1::AddCommentReplyRequest]
5226
+ attr_accessor :add_comment_reply
5227
+
4705
5228
  # Adds a document tab. When a tab is added at a given index, all subsequent tabs'
4706
5229
  # indexes are incremented.
4707
5230
  # Corresponds to the JSON property `addDocumentTab`
@@ -4747,6 +5270,21 @@ module Google
4747
5270
  # @return [Google::Apis::DocsV1::CreateParagraphBulletsRequest]
4748
5271
  attr_accessor :create_paragraph_bullets
4749
5272
 
5273
+ # Deletes a CommentThread. Returns a 400 bad request error if the requesting
5274
+ # user is not the author of the headPost. [Developer Preview](https://developers.
5275
+ # google.com/workspace/preview).
5276
+ # Corresponds to the JSON property `deleteComment`
5277
+ # @return [Google::Apis::DocsV1::DeleteCommentRequest]
5278
+ attr_accessor :delete_comment
5279
+
5280
+ # Deletes a reply Post from a CommentThread or SuggestionThread. Returns a 400
5281
+ # bad request error if: - The requesting user is not the author of the post. -
5282
+ # The reply post contains an action. - The reply post contains an assignee. [
5283
+ # Developer Preview](https://developers.google.com/workspace/preview).
5284
+ # Corresponds to the JSON property `deleteCommentReply`
5285
+ # @return [Google::Apis::DocsV1::DeleteCommentReplyRequest]
5286
+ attr_accessor :delete_comment_reply
5287
+
4750
5288
  # Deletes content from the document.
4751
5289
  # Corresponds to the JSON property `deleteContentRange`
4752
5290
  # @return [Google::Apis::DocsV1::DeleteContentRangeRequest]
@@ -4779,6 +5317,13 @@ module Google
4779
5317
  # @return [Google::Apis::DocsV1::DeletePositionedObjectRequest]
4780
5318
  attr_accessor :delete_positioned_object
4781
5319
 
5320
+ # Deletes a suggestion. Returns a 403 forbidden error if the requesting user is
5321
+ # not the author of the suggestion. [Developer Preview](https://developers.
5322
+ # google.com/workspace/preview).
5323
+ # Corresponds to the JSON property `deleteSuggestion`
5324
+ # @return [Google::Apis::DocsV1::DeleteSuggestionRequest]
5325
+ attr_accessor :delete_suggestion
5326
+
4782
5327
  # Deletes a tab. If the tab has child tabs, they are deleted as well.
4783
5328
  # Corresponds to the JSON property `deleteTab`
4784
5329
  # @return [Google::Apis::DocsV1::DeleteTabRequest]
@@ -4794,6 +5339,12 @@ module Google
4794
5339
  # @return [Google::Apis::DocsV1::DeleteTableRowRequest]
4795
5340
  attr_accessor :delete_table_row
4796
5341
 
5342
+ # Inserts a CommentThread into the document. [Developer Preview](https://
5343
+ # developers.google.com/workspace/preview).
5344
+ # Corresponds to the JSON property `insertComment`
5345
+ # @return [Google::Apis::DocsV1::InsertCommentRequest]
5346
+ attr_accessor :insert_comment
5347
+
4797
5348
  # Inserts a date at the specified location.
4798
5349
  # Corresponds to the JSON property `insertDate`
4799
5350
  # @return [Google::Apis::DocsV1::InsertDateRequest]
@@ -4856,6 +5407,14 @@ module Google
4856
5407
  # @return [Google::Apis::DocsV1::PinTableHeaderRowsRequest]
4857
5408
  attr_accessor :pin_table_header_rows
4858
5409
 
5410
+ # Rejects a suggestion. Returns a 403 forbidden error if the requesting user
5411
+ # does not have edit access to the document and is not the author of the
5412
+ # suggestion. [Developer Preview](https://developers.google.com/workspace/
5413
+ # preview).
5414
+ # Corresponds to the JSON property `rejectSuggestion`
5415
+ # @return [Google::Apis::DocsV1::RejectSuggestionRequest]
5416
+ attr_accessor :reject_suggestion
5417
+
4859
5418
  # Replaces all instances of text matching a criteria with replace text.
4860
5419
  # Corresponds to the JSON property `replaceAllText`
4861
5420
  # @return [Google::Apis::DocsV1::ReplaceAllTextRequest]
@@ -4883,6 +5442,14 @@ module Google
4883
5442
  # @return [Google::Apis::DocsV1::UnmergeTableCellsRequest]
4884
5443
  attr_accessor :unmerge_table_cells
4885
5444
 
5445
+ # Updates a Post in a CommentThread or SuggestionThread. Returns a 400 bad
5446
+ # request error if: - The post is the headPost of a SuggestionThread. - The
5447
+ # requesting user is not the author of the post. [Developer Preview](https://
5448
+ # developers.google.com/workspace/preview).
5449
+ # Corresponds to the JSON property `updateCommentPost`
5450
+ # @return [Google::Apis::DocsV1::UpdateCommentPostRequest]
5451
+ attr_accessor :update_comment_post
5452
+
4886
5453
  # Updates the DocumentStyle.
4887
5454
  # Corresponds to the JSON property `updateDocumentStyle`
4888
5455
  # @return [Google::Apis::DocsV1::UpdateDocumentStyleRequest]
@@ -4934,21 +5501,27 @@ module Google
4934
5501
 
4935
5502
  # Update properties of this object
4936
5503
  def update!(**args)
5504
+ @accept_suggestion = args[:accept_suggestion] if args.key?(:accept_suggestion)
5505
+ @add_comment_reply = args[:add_comment_reply] if args.key?(:add_comment_reply)
4937
5506
  @add_document_tab = args[:add_document_tab] if args.key?(:add_document_tab)
4938
5507
  @create_footer = args[:create_footer] if args.key?(:create_footer)
4939
5508
  @create_footnote = args[:create_footnote] if args.key?(:create_footnote)
4940
5509
  @create_header = args[:create_header] if args.key?(:create_header)
4941
5510
  @create_named_range = args[:create_named_range] if args.key?(:create_named_range)
4942
5511
  @create_paragraph_bullets = args[:create_paragraph_bullets] if args.key?(:create_paragraph_bullets)
5512
+ @delete_comment = args[:delete_comment] if args.key?(:delete_comment)
5513
+ @delete_comment_reply = args[:delete_comment_reply] if args.key?(:delete_comment_reply)
4943
5514
  @delete_content_range = args[:delete_content_range] if args.key?(:delete_content_range)
4944
5515
  @delete_footer = args[:delete_footer] if args.key?(:delete_footer)
4945
5516
  @delete_header = args[:delete_header] if args.key?(:delete_header)
4946
5517
  @delete_named_range = args[:delete_named_range] if args.key?(:delete_named_range)
4947
5518
  @delete_paragraph_bullets = args[:delete_paragraph_bullets] if args.key?(:delete_paragraph_bullets)
4948
5519
  @delete_positioned_object = args[:delete_positioned_object] if args.key?(:delete_positioned_object)
5520
+ @delete_suggestion = args[:delete_suggestion] if args.key?(:delete_suggestion)
4949
5521
  @delete_tab = args[:delete_tab] if args.key?(:delete_tab)
4950
5522
  @delete_table_column = args[:delete_table_column] if args.key?(:delete_table_column)
4951
5523
  @delete_table_row = args[:delete_table_row] if args.key?(:delete_table_row)
5524
+ @insert_comment = args[:insert_comment] if args.key?(:insert_comment)
4952
5525
  @insert_date = args[:insert_date] if args.key?(:insert_date)
4953
5526
  @insert_inline_image = args[:insert_inline_image] if args.key?(:insert_inline_image)
4954
5527
  @insert_page_break = args[:insert_page_break] if args.key?(:insert_page_break)
@@ -4961,10 +5534,12 @@ module Google
4961
5534
  @insert_text = args[:insert_text] if args.key?(:insert_text)
4962
5535
  @merge_table_cells = args[:merge_table_cells] if args.key?(:merge_table_cells)
4963
5536
  @pin_table_header_rows = args[:pin_table_header_rows] if args.key?(:pin_table_header_rows)
5537
+ @reject_suggestion = args[:reject_suggestion] if args.key?(:reject_suggestion)
4964
5538
  @replace_all_text = args[:replace_all_text] if args.key?(:replace_all_text)
4965
5539
  @replace_image = args[:replace_image] if args.key?(:replace_image)
4966
5540
  @replace_named_range_content = args[:replace_named_range_content] if args.key?(:replace_named_range_content)
4967
5541
  @unmerge_table_cells = args[:unmerge_table_cells] if args.key?(:unmerge_table_cells)
5542
+ @update_comment_post = args[:update_comment_post] if args.key?(:update_comment_post)
4968
5543
  @update_document_style = args[:update_document_style] if args.key?(:update_document_style)
4969
5544
  @update_document_tab_properties = args[:update_document_tab_properties] if args.key?(:update_document_tab_properties)
4970
5545
  @update_named_style = args[:update_named_style] if args.key?(:update_named_style)
@@ -4981,6 +5556,12 @@ module Google
4981
5556
  class Response
4982
5557
  include Google::Apis::Core::Hashable
4983
5558
 
5559
+ # Response message for adding a reply. [Developer Preview](https://developers.
5560
+ # google.com/workspace/preview).
5561
+ # Corresponds to the JSON property `addCommentReply`
5562
+ # @return [Google::Apis::DocsV1::AddCommentReplyResponse]
5563
+ attr_accessor :add_comment_reply
5564
+
4984
5565
  # The result of adding a document tab.
4985
5566
  # Corresponds to the JSON property `addDocumentTab`
4986
5567
  # @return [Google::Apis::DocsV1::AddDocumentTabResponse]
@@ -5006,6 +5587,12 @@ module Google
5006
5587
  # @return [Google::Apis::DocsV1::CreateNamedRangeResponse]
5007
5588
  attr_accessor :create_named_range
5008
5589
 
5590
+ # Response message for inserting a comment. [Developer Preview](https://
5591
+ # developers.google.com/workspace/preview).
5592
+ # Corresponds to the JSON property `insertComment`
5593
+ # @return [Google::Apis::DocsV1::InsertCommentResponse]
5594
+ attr_accessor :insert_comment
5595
+
5009
5596
  # The result of inserting an inline image.
5010
5597
  # Corresponds to the JSON property `insertInlineImage`
5011
5598
  # @return [Google::Apis::DocsV1::InsertInlineImageResponse]
@@ -5027,11 +5614,13 @@ module Google
5027
5614
 
5028
5615
  # Update properties of this object
5029
5616
  def update!(**args)
5617
+ @add_comment_reply = args[:add_comment_reply] if args.key?(:add_comment_reply)
5030
5618
  @add_document_tab = args[:add_document_tab] if args.key?(:add_document_tab)
5031
5619
  @create_footer = args[:create_footer] if args.key?(:create_footer)
5032
5620
  @create_footnote = args[:create_footnote] if args.key?(:create_footnote)
5033
5621
  @create_header = args[:create_header] if args.key?(:create_header)
5034
5622
  @create_named_range = args[:create_named_range] if args.key?(:create_named_range)
5623
+ @insert_comment = args[:insert_comment] if args.key?(:insert_comment)
5035
5624
  @insert_inline_image = args[:insert_inline_image] if args.key?(:insert_inline_image)
5036
5625
  @insert_inline_sheets_chart = args[:insert_inline_sheets_chart] if args.key?(:insert_inline_sheets_chart)
5037
5626
  @replace_all_text = args[:replace_all_text] if args.key?(:replace_all_text)
@@ -5970,6 +6559,104 @@ module Google
5970
6559
  end
5971
6560
  end
5972
6561
 
6562
+ # The suggestions which were affected by a given update. [Developer Preview](
6563
+ # https://developers.google.com/workspace/preview).
6564
+ class SuggestionResponse
6565
+ include Google::Apis::Core::Hashable
6566
+
6567
+ # The IDs of suggestions which were accepted during the update.
6568
+ # Corresponds to the JSON property `acceptedSuggestionIds`
6569
+ # @return [Array<String>]
6570
+ attr_accessor :accepted_suggestion_ids
6571
+
6572
+ # The IDs of suggestions which were created during the update.
6573
+ # Corresponds to the JSON property `createdSuggestionIds`
6574
+ # @return [Array<String>]
6575
+ attr_accessor :created_suggestion_ids
6576
+
6577
+ # The IDs of suggestions which were deleted during the update.
6578
+ # Corresponds to the JSON property `deletedSuggestionIds`
6579
+ # @return [Array<String>]
6580
+ attr_accessor :deleted_suggestion_ids
6581
+
6582
+ # The IDs of suggestions which were rejected during the update.
6583
+ # Corresponds to the JSON property `rejectedSuggestionIds`
6584
+ # @return [Array<String>]
6585
+ attr_accessor :rejected_suggestion_ids
6586
+
6587
+ # The IDs of suggestions whose summaries were updated during the update.
6588
+ # Corresponds to the JSON property `updatedSummarySuggestionIds`
6589
+ # @return [Array<String>]
6590
+ attr_accessor :updated_summary_suggestion_ids
6591
+
6592
+ def initialize(**args)
6593
+ update!(**args)
6594
+ end
6595
+
6596
+ # Update properties of this object
6597
+ def update!(**args)
6598
+ @accepted_suggestion_ids = args[:accepted_suggestion_ids] if args.key?(:accepted_suggestion_ids)
6599
+ @created_suggestion_ids = args[:created_suggestion_ids] if args.key?(:created_suggestion_ids)
6600
+ @deleted_suggestion_ids = args[:deleted_suggestion_ids] if args.key?(:deleted_suggestion_ids)
6601
+ @rejected_suggestion_ids = args[:rejected_suggestion_ids] if args.key?(:rejected_suggestion_ids)
6602
+ @updated_summary_suggestion_ids = args[:updated_summary_suggestion_ids] if args.key?(:updated_summary_suggestion_ids)
6603
+ end
6604
+ end
6605
+
6606
+ # Represents a single suggestion thread. Suggestion threads are created as a
6607
+ # byproduct of saving changes to the document while in suggestion mode, and
6608
+ # cannot be created directly. [Developer Preview](https://developers.google.com/
6609
+ # workspace/preview).
6610
+ class SuggestionThread
6611
+ include Google::Apis::Core::Hashable
6612
+
6613
+ # Represents a single post in a comment or suggestion thread. [Developer Preview]
6614
+ # (https://developers.google.com/workspace/preview).
6615
+ # Corresponds to the JSON property `headPost`
6616
+ # @return [Google::Apis::DocsV1::Post]
6617
+ attr_accessor :head_post
6618
+
6619
+ # Replies to the head post.
6620
+ # Corresponds to the JSON property `replies`
6621
+ # @return [Array<Google::Apis::DocsV1::Post>]
6622
+ attr_accessor :replies
6623
+
6624
+ # Whether the thread is open, accepted, or rejected.
6625
+ # Corresponds to the JSON property `status`
6626
+ # @return [String]
6627
+ attr_accessor :status
6628
+
6629
+ # The unique ID of the suggestion.
6630
+ # Corresponds to the JSON property `suggestionId`
6631
+ # @return [String]
6632
+ attr_accessor :suggestion_id
6633
+
6634
+ # Summary of the suggested differences in the document, in HTML. May be empty.
6635
+ # Corresponds to the JSON property `summaryHtml`
6636
+ # @return [String]
6637
+ attr_accessor :summary_html
6638
+
6639
+ # Summary of the suggested differences in the document, in plain text. May be
6640
+ # empty.
6641
+ # Corresponds to the JSON property `summaryText`
6642
+ # @return [String]
6643
+ attr_accessor :summary_text
6644
+
6645
+ def initialize(**args)
6646
+ update!(**args)
6647
+ end
6648
+
6649
+ # Update properties of this object
6650
+ def update!(**args)
6651
+ @head_post = args[:head_post] if args.key?(:head_post)
6652
+ @replies = args[:replies] if args.key?(:replies)
6653
+ @status = args[:status] if args.key?(:status)
6654
+ @suggestion_id = args[:suggestion_id] if args.key?(:suggestion_id)
6655
+ @summary_html = args[:summary_html] if args.key?(:summary_html)
6656
+ @summary_text = args[:summary_text] if args.key?(:summary_text)
6657
+ end
6658
+ end
6659
+
5973
6660
  # A tab in a document.
5974
6661
  class Tab
5975
6662
  include Google::Apis::Core::Hashable
@@ -6962,6 +7649,49 @@ module Google
6962
7649
  end
6963
7650
  end
6964
7651
 
7652
+ # Updates a Post in a CommentThread or SuggestionThread. Returns a 400 bad
7653
+ # request error if: - The post is the headPost of a SuggestionThread. - The
7654
+ # requesting user is not the author of the post. [Developer Preview](https://
7655
+ # developers.google.com/workspace/preview).
7656
+ class UpdateCommentPostRequest
7657
+ include Google::Apis::Core::Hashable
7658
+
7659
+ # The ID of the CommentThread which the post belongs to.
7660
+ # Corresponds to the JSON property `commentId`
7661
+ # @return [String]
7662
+ attr_accessor :comment_id
7663
+
7664
+ # The new text of the comment, as plain text. This text content will be handled
7665
+ # similarly to comments created in the Docs editor. It will have similar
7666
+ # behaviors for formatting, notifications, etc. This field cannot be empty, and
7667
+ # must not exceed 2048 UTF-8 code units.
7668
+ # Corresponds to the JSON property `content`
7669
+ # @return [String]
7670
+ attr_accessor :content
7671
+
7672
+ # The ID of the post being updated.
7673
+ # Corresponds to the JSON property `postId`
7674
+ # @return [String]
7675
+ attr_accessor :post_id
7676
+
7677
+ # The ID of the SuggestionThread which the post belongs to.
7678
+ # Corresponds to the JSON property `suggestionId`
7679
+ # @return [String]
7680
+ attr_accessor :suggestion_id
7681
+
7682
+ def initialize(**args)
7683
+ update!(**args)
7684
+ end
7685
+
7686
+ # Update properties of this object
7687
+ def update!(**args)
7688
+ @comment_id = args[:comment_id] if args.key?(:comment_id)
7689
+ @content = args[:content] if args.key?(:content)
7690
+ @post_id = args[:post_id] if args.key?(:post_id)
7691
+ @suggestion_id = args[:suggestion_id] if args.key?(:suggestion_id)
7692
+ end
7693
+ end
7694
+
6965
7695
  # Updates the DocumentStyle.
6966
7696
  class UpdateDocumentStyleRequest
6967
7697
  include Google::Apis::Core::Hashable
@@ -7394,6 +8124,13 @@ module Google
7394
8124
  # @return [String]
7395
8125
  attr_accessor :target_revision_id
7396
8126
 
8127
+ # How the request updates should be applied to the document. If unspecified, the
8128
+ # request updates will be applied as normal edits. [Developer Preview](https://
8129
+ # developers.google.com/workspace/preview).
8130
+ # Corresponds to the JSON property `writeMode`
8131
+ # @return [String]
8132
+ attr_accessor :write_mode
8133
+
7397
8134
  def initialize(**args)
7398
8135
  update!(**args)
7399
8136
  end
@@ -7402,6 +8139,7 @@ module Google
7402
8139
  def update!(**args)
7403
8140
  @required_revision_id = args[:required_revision_id] if args.key?(:required_revision_id)
7404
8141
  @target_revision_id = args[:target_revision_id] if args.key?(:target_revision_id)
8142
+ @write_mode = args[:write_mode] if args.key?(:write_mode)
7405
8143
  end
7406
8144
  end
7407
8145
  end