/
service.rb
371 lines (358 loc) · 22.2 KB
/
service.rb
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
# 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 LicensingV1
# Enterprise License Manager API
#
# The Google Enterprise License Manager API's allows you to license apps for all
# the users of a domain managed by you.
#
# @example
# require 'google/apis/licensing_v1'
#
# Licensing = Google::Apis::LicensingV1 # Alias the module
# service = Licensing::LicensingService.new
#
# @see https://developers.google.com/admin-sdk/licensing/
class LicensingService < 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]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://licensing.googleapis.com/', '')
@batch_path = 'batch'
end
# Revoke a license.
# @param [String] product_id
# A product's unique identifier. For more information about products in this
# version of the API, see Products and SKUs.
# @param [String] sku_id
# A product SKU's unique identifier. For more information about available SKUs
# in this version of the API, see Products and SKUs.
# @param [String] user_id
# The user's current primary email address. If the user's email address changes,
# use the new email address in your API requests. Since a `userId` is subject to
# change, do not use a `userId` value as a key for persistent data. This key
# could break if the current user's email address changes. If the `userId` is
# suspended, the license status changes.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LicensingV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LicensingV1::Empty]
#
# @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 delete_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}', options)
command.response_representation = Google::Apis::LicensingV1::Empty::Representation
command.response_class = Google::Apis::LicensingV1::Empty
command.params['productId'] = product_id unless product_id.nil?
command.params['skuId'] = sku_id unless sku_id.nil?
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?
execute_or_queue_command(command, &block)
end
# Get a specific user's license by product SKU.
# @param [String] product_id
# A product's unique identifier. For more information about products in this
# version of the API, see Products and SKUs.
# @param [String] sku_id
# A product SKU's unique identifier. For more information about available SKUs
# in this version of the API, see Products and SKUs.
# @param [String] user_id
# The user's current primary email address. If the user's email address changes,
# use the new email address in your API requests. Since a `userId` is subject to
# change, do not use a `userId` value as a key for persistent data. This key
# could break if the current user's email address changes. If the `userId` is
# suspended, the license status changes.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LicensingV1::LicenseAssignment]
#
# @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_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}', options)
command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
command.response_class = Google::Apis::LicensingV1::LicenseAssignment
command.params['productId'] = product_id unless product_id.nil?
command.params['skuId'] = sku_id unless sku_id.nil?
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?
execute_or_queue_command(command, &block)
end
# Assign a license.
# @param [String] product_id
# A product's unique identifier. For more information about products in this
# version of the API, see Products and SKUs.
# @param [String] sku_id
# A product SKU's unique identifier. For more information about available SKUs
# in this version of the API, see Products and SKUs.
# @param [Google::Apis::LicensingV1::LicenseAssignmentInsert] license_assignment_insert_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LicensingV1::LicenseAssignment]
#
# @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_license_assignment(product_id, sku_id, license_assignment_insert_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user', options)
command.request_representation = Google::Apis::LicensingV1::LicenseAssignmentInsert::Representation
command.request_object = license_assignment_insert_object
command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
command.response_class = Google::Apis::LicensingV1::LicenseAssignment
command.params['productId'] = product_id unless product_id.nil?
command.params['skuId'] = sku_id unless sku_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List all users assigned licenses for a specific product SKU.
# @param [String] product_id
# A product's unique identifier. For more information about products in this
# version of the API, see Products and SKUs.
# @param [String] customer_id
# Customer's `customerId`. A previous version of this API accepted the primary
# domain name as a value for this field. If the customer is suspended, the
# server returns an error.
# @param [Fixnum] max_results
# The `maxResults` query string determines how many entries are returned on each
# page of a large response. This is an optional parameter. The value must be a
# positive number.
# @param [String] page_token
# Token to fetch the next page of data. The `maxResults` query string is related
# to the `pageToken` since `maxResults` determines how many entries are returned
# on each page. This is an optional query string. If not specified, the server
# returns the first page.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LicensingV1::LicenseAssignmentList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LicensingV1::LicenseAssignmentList]
#
# @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_license_assignments_for_product(product_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'apps/licensing/v1/product/{productId}/users', options)
command.response_representation = Google::Apis::LicensingV1::LicenseAssignmentList::Representation
command.response_class = Google::Apis::LicensingV1::LicenseAssignmentList
command.params['productId'] = product_id unless product_id.nil?
command.query['customerId'] = customer_id unless customer_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?
execute_or_queue_command(command, &block)
end
# List all users assigned licenses for a specific product SKU.
# @param [String] product_id
# A product's unique identifier. For more information about products in this
# version of the API, see Products and SKUs.
# @param [String] sku_id
# A product SKU's unique identifier. For more information about available SKUs
# in this version of the API, see Products and SKUs.
# @param [String] customer_id
# Customer's `customerId`. A previous version of this API accepted the primary
# domain name as a value for this field. If the customer is suspended, the
# server returns an error.
# @param [Fixnum] max_results
# The `maxResults` query string determines how many entries are returned on each
# page of a large response. This is an optional parameter. The value must be a
# positive number.
# @param [String] page_token
# Token to fetch the next page of data. The `maxResults` query string is related
# to the `pageToken` since `maxResults` determines how many entries are returned
# on each page. This is an optional query string. If not specified, the server
# returns the first page.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LicensingV1::LicenseAssignmentList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LicensingV1::LicenseAssignmentList]
#
# @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_license_assignments_for_product_and_sku(product_id, sku_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'apps/licensing/v1/product/{productId}/sku/{skuId}/users', options)
command.response_representation = Google::Apis::LicensingV1::LicenseAssignmentList::Representation
command.response_class = Google::Apis::LicensingV1::LicenseAssignmentList
command.params['productId'] = product_id unless product_id.nil?
command.params['skuId'] = sku_id unless sku_id.nil?
command.query['customerId'] = customer_id unless customer_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?
execute_or_queue_command(command, &block)
end
# Reassign a user's product SKU with a different SKU in the same product. This
# method supports patch semantics.
# @param [String] product_id
# A product's unique identifier. For more information about products in this
# version of the API, see Products and SKUs.
# @param [String] sku_id
# A product SKU's unique identifier. For more information about available SKUs
# in this version of the API, see Products and SKUs.
# @param [String] user_id
# The user's current primary email address. If the user's email address changes,
# use the new email address in your API requests. Since a `userId` is subject to
# change, do not use a `userId` value as a key for persistent data. This key
# could break if the current user's email address changes. If the `userId` is
# suspended, the license status changes.
# @param [Google::Apis::LicensingV1::LicenseAssignment] license_assignment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LicensingV1::LicenseAssignment]
#
# @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 patch_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}', options)
command.request_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
command.request_object = license_assignment_object
command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
command.response_class = Google::Apis::LicensingV1::LicenseAssignment
command.params['productId'] = product_id unless product_id.nil?
command.params['skuId'] = sku_id unless sku_id.nil?
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?
execute_or_queue_command(command, &block)
end
# Reassign a user's product SKU with a different SKU in the same product.
# @param [String] product_id
# A product's unique identifier. For more information about products in this
# version of the API, see Products and SKUs.
# @param [String] sku_id
# A product SKU's unique identifier. For more information about available SKUs
# in this version of the API, see Products and SKUs.
# @param [String] user_id
# The user's current primary email address. If the user's email address changes,
# use the new email address in your API requests. Since a `userId` is subject to
# change, do not use a `userId` value as a key for persistent data. This key
# could break if the current user's email address changes. If the `userId` is
# suspended, the license status changes.
# @param [Google::Apis::LicensingV1::LicenseAssignment] license_assignment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LicensingV1::LicenseAssignment]
#
# @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 update_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}', options)
command.request_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
command.request_object = license_assignment_object
command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
command.response_class = Google::Apis::LicensingV1::LicenseAssignment
command.params['productId'] = product_id unless product_id.nil?
command.params['skuId'] = sku_id unless sku_id.nil?
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?
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?
end
end
end
end
end