1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module PlusDomainsV1
# Google+ Domains API
#
# Builds on top of the Google+ platform for Google Apps Domains.
#
# @example
# require 'google/apis/plus_domains_v1'
#
# PlusDomains = Google::Apis::PlusDomainsV1 # Alias the module
# service = PlusDomains::PlusDomainsService.new
#
# @see https://developers.google.com/+/domains/
class PlusDomainsService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'plusDomains/v1/')
@batch_path = 'batch/plusDomains/v1'
end
# Shut down. See https://developers.google.com/+/api-shutdown for more details.
# @param [String] activity_id
# The ID of the activity to get.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::Activity] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::Activity]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_activity(activity_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'activities/{activityId}', options)
command.response_representation = Google::Apis::PlusDomainsV1::Activity::Representation
command.response_class = Google::Apis::PlusDomainsV1::Activity
command.params['activityId'] = activity_id unless activity_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Shut down. See https://developers.google.com/+/api-shutdown for more details.
# @param [String] user_id
# The ID of the user to get activities for. The special value "me" can be used
# to indicate the authenticated user.
# @param [String] collection
# The collection of activities to list.
# @param [Fixnum] max_results
# The maximum number of activities to include in the response, which is used for
# paging. For any response, the actual number returned might be less than the
# specified maxResults.
# @param [String] page_token
# The continuation token, which is used to page through large result sets. To
# get the next page of results, set this parameter to the value of "
# nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::ActivityFeed] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::ActivityFeed]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_activities(user_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'people/{userId}/activities/{collection}', options)
command.response_representation = Google::Apis::PlusDomainsV1::ActivityFeed::Representation
command.response_class = Google::Apis::PlusDomainsV1::ActivityFeed
command.params['userId'] = user_id unless user_id.nil?
command.params['collection'] = collection unless collection.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Shut down. See https://developers.google.com/+/api-shutdown for more details.
# @param [String] user_id
# The ID of the user to get audiences for. The special value "me" can be used to
# indicate the authenticated user.
# @param [Fixnum] max_results
# The maximum number of circles to include in the response, which is used for
# paging. For any response, the actual number returned might be less than the
# specified maxResults.
# @param [String] page_token
# The continuation token, which is used to page through large result sets. To
# get the next page of results, set this parameter to the value of "
# nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::AudiencesFeed] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::AudiencesFeed]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_audiences(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'people/{userId}/audiences', options)
command.response_representation = Google::Apis::PlusDomainsV1::AudiencesFeed::Representation
command.response_class = Google::Apis::PlusDomainsV1::AudiencesFeed
command.params['userId'] = user_id unless user_id.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Shut down. See https://developers.google.com/+/api-shutdown for more details.
# @param [String] user_id
# The ID of the user to get circles for. The special value "me" can be used to
# indicate the authenticated user.
# @param [Fixnum] max_results
# The maximum number of circles to include in the response, which is used for
# paging. For any response, the actual number returned might be less than the
# specified maxResults.
# @param [String] page_token
# The continuation token, which is used to page through large result sets. To
# get the next page of results, set this parameter to the value of "
# nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::CircleFeed] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::CircleFeed]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_circles(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'people/{userId}/circles', options)
command.response_representation = Google::Apis::PlusDomainsV1::CircleFeed::Representation
command.response_class = Google::Apis::PlusDomainsV1::CircleFeed
command.params['userId'] = user_id unless user_id.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Shut down. See https://developers.google.com/+/api-shutdown for more details.
# @param [String] comment_id
# The ID of the comment to get.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::Comment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::Comment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_comment(comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'comments/{commentId}', options)
command.response_representation = Google::Apis::PlusDomainsV1::Comment::Representation
command.response_class = Google::Apis::PlusDomainsV1::Comment
command.params['commentId'] = comment_id unless comment_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Shut down. See https://developers.google.com/+/api-shutdown for more details.
# @param [String] activity_id
# The ID of the activity to get comments for.
# @param [Fixnum] max_results
# The maximum number of comments to include in the response, which is used for
# paging. For any response, the actual number returned might be less than the
# specified maxResults.
# @param [String] page_token
# The continuation token, which is used to page through large result sets. To
# get the next page of results, set this parameter to the value of "
# nextPageToken" from the previous response.
# @param [String] sort_order
# The order in which to sort the list of comments.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::CommentFeed] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::CommentFeed]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_comments(activity_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'activities/{activityId}/comments', options)
command.response_representation = Google::Apis::PlusDomainsV1::CommentFeed::Representation
command.response_class = Google::Apis::PlusDomainsV1::CommentFeed
command.params['activityId'] = activity_id unless activity_id.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['sortOrder'] = sort_order unless sort_order.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Shut down. See https://developers.google.com/+/api-shutdown for more details.
# @param [String] user_id
# The ID of the user to create the activity on behalf of.
# @param [String] collection
# @param [Google::Apis::PlusDomainsV1::Media] media_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [IO, String] upload_source
# IO stream or filename containing content to upload
# @param [String] content_type
# Content type of the uploaded content.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::Media] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::Media]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_medium(user_id, collection, media_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:post, 'people/{userId}/media/{collection}', options)
else
command = make_upload_command(:post, 'people/{userId}/media/{collection}', options)
command.upload_source = upload_source
command.upload_content_type = content_type
end
command.request_representation = Google::Apis::PlusDomainsV1::Media::Representation
command.request_object = media_object
command.response_representation = Google::Apis::PlusDomainsV1::Media::Representation
command.response_class = Google::Apis::PlusDomainsV1::Media
command.params['userId'] = user_id unless user_id.nil?
command.params['collection'] = collection unless collection.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Get a person's profile.
# @param [String] user_id
# The ID of the person to get the profile for. The special value "me" can be
# used to indicate the authenticated user.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::Person] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::Person]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_person(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'people/{userId}', options)
command.response_representation = Google::Apis::PlusDomainsV1::Person::Representation
command.response_class = Google::Apis::PlusDomainsV1::Person
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all of the people in the specified collection.
# @param [String] user_id
# Get the collection of people for the person identified. Use "me" to indicate
# the authenticated user.
# @param [String] collection
# The collection of people to list.
# @param [Fixnum] max_results
# The maximum number of people to include in the response, which is used for
# paging. For any response, the actual number returned might be less than the
# specified maxResults.
# @param [String] order_by
# The order to return people in.
# @param [String] page_token
# The continuation token, which is used to page through large result sets. To
# get the next page of results, set this parameter to the value of "
# nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::PeopleFeed] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::PeopleFeed]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_people(user_id, collection, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'people/{userId}/people/{collection}', options)
command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation
command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed
command.params['userId'] = user_id unless user_id.nil?
command.params['collection'] = collection unless collection.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Shut down. See https://developers.google.com/+/api-shutdown for more details.
# @param [String] activity_id
# The ID of the activity to get the list of people for.
# @param [String] collection
# The collection of people to list.
# @param [Fixnum] max_results
# The maximum number of people to include in the response, which is used for
# paging. For any response, the actual number returned might be less than the
# specified maxResults.
# @param [String] page_token
# The continuation token, which is used to page through large result sets. To
# get the next page of results, set this parameter to the value of "
# nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PlusDomainsV1::PeopleFeed] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PlusDomainsV1::PeopleFeed]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_people_by_activity(activity_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'activities/{activityId}/people/{collection}', options)
command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation
command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed
command.params['activityId'] = activity_id unless activity_id.nil?
command.params['collection'] = collection unless collection.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
end
end
end
end
end
|
