v1.d.ts
18 KB
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
/**
* Copyright 2019 Google LLC
*
* 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.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace licensing_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not
* exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Enterprise License Manager API
*
* Views and manages licenses for your domain.
*
* @example
* const {google} = require('googleapis');
* const licensing = google.licensing('v1');
*
* @namespace licensing
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Licensing
*/
class Licensing {
context: APIRequestContext;
licenseAssignments: Resource$Licenseassignments;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Template for LiscenseAssignment Resource
*/
interface Schema$LicenseAssignment {
/**
* ETag of the resource.
*/
etags?: string;
/**
* Identifies the resource as a LicenseAssignment.
*/
kind?: string;
/**
* Id of the product.
*/
productId?: string;
/**
* Display Name of the product.
*/
productName?: string;
/**
* Link to this page.
*/
selfLink?: string;
/**
* Id of the sku of the product.
*/
skuId?: string;
/**
* Display Name of the sku of the product.
*/
skuName?: string;
/**
* Email id of the user.
*/
userId?: string;
}
/**
* Template for LicenseAssignment Insert request
*/
interface Schema$LicenseAssignmentInsert {
/**
* Email id of the user
*/
userId?: string;
}
/**
* LicesnseAssignment List for a given product/sku for a customer.
*/
interface Schema$LicenseAssignmentList {
/**
* ETag of the resource.
*/
etag?: string;
/**
* The LicenseAssignments in this page of results.
*/
items?: Schema$LicenseAssignment[];
/**
* Identifies the resource as a collection of LicenseAssignments.
*/
kind?: string;
/**
* The continuation token, used to page through large result sets. Provide
* this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string;
}
class Resource$Licenseassignments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* licensing.licenseAssignments.delete
* @desc Revoke License.
* @alias licensing.licenseAssignments.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.productId Name for product
* @param {string} params.skuId Name for sku
* @param {string} params.userId email id or unique Id of the user
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Licenseassignments$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Licenseassignments$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Licenseassignments$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* licensing.licenseAssignments.get
* @desc Get license assignment of a particular product and sku for a user
* @alias licensing.licenseAssignments.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.productId Name for product
* @param {string} params.skuId Name for sku
* @param {string} params.userId email id or unique Id of the user
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Licenseassignments$Get, options?: MethodOptions): GaxiosPromise<Schema$LicenseAssignment>;
get(params: Params$Resource$Licenseassignments$Get, options: MethodOptions | BodyResponseCallback<Schema$LicenseAssignment>, callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
get(params: Params$Resource$Licenseassignments$Get, callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
get(callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
/**
* licensing.licenseAssignments.insert
* @desc Assign License.
* @alias licensing.licenseAssignments.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.productId Name for product
* @param {string} params.skuId Name for sku
* @param {().LicenseAssignmentInsert} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Licenseassignments$Insert, options?: MethodOptions): GaxiosPromise<Schema$LicenseAssignment>;
insert(params: Params$Resource$Licenseassignments$Insert, options: MethodOptions | BodyResponseCallback<Schema$LicenseAssignment>, callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
insert(params: Params$Resource$Licenseassignments$Insert, callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
insert(callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
/**
* licensing.licenseAssignments.listForProduct
* @desc List license assignments for given product of the customer.
* @alias licensing.licenseAssignments.listForProduct
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId CustomerId represents the customer for whom licenseassignments are queried
* @param {integer=} params.maxResults Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
* @param {string=} params.pageToken Token to fetch the next page.Optional. By default server will return first page
* @param {string} params.productId Name for product
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
listForProduct(params?: Params$Resource$Licenseassignments$Listforproduct, options?: MethodOptions): GaxiosPromise<Schema$LicenseAssignmentList>;
listForProduct(params: Params$Resource$Licenseassignments$Listforproduct, options: MethodOptions | BodyResponseCallback<Schema$LicenseAssignmentList>, callback: BodyResponseCallback<Schema$LicenseAssignmentList>): void;
listForProduct(params: Params$Resource$Licenseassignments$Listforproduct, callback: BodyResponseCallback<Schema$LicenseAssignmentList>): void;
listForProduct(callback: BodyResponseCallback<Schema$LicenseAssignmentList>): void;
/**
* licensing.licenseAssignments.listForProductAndSku
* @desc List license assignments for given product and sku of the customer.
* @alias licensing.licenseAssignments.listForProductAndSku
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.customerId CustomerId represents the customer for whom licenseassignments are queried
* @param {integer=} params.maxResults Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
* @param {string=} params.pageToken Token to fetch the next page.Optional. By default server will return first page
* @param {string} params.productId Name for product
* @param {string} params.skuId Name for sku
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
listForProductAndSku(params?: Params$Resource$Licenseassignments$Listforproductandsku, options?: MethodOptions): GaxiosPromise<Schema$LicenseAssignmentList>;
listForProductAndSku(params: Params$Resource$Licenseassignments$Listforproductandsku, options: MethodOptions | BodyResponseCallback<Schema$LicenseAssignmentList>, callback: BodyResponseCallback<Schema$LicenseAssignmentList>): void;
listForProductAndSku(params: Params$Resource$Licenseassignments$Listforproductandsku, callback: BodyResponseCallback<Schema$LicenseAssignmentList>): void;
listForProductAndSku(callback: BodyResponseCallback<Schema$LicenseAssignmentList>): void;
/**
* licensing.licenseAssignments.patch
* @desc Assign License. This method supports patch semantics.
* @alias licensing.licenseAssignments.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.productId Name for product
* @param {string} params.skuId Name for sku for which license would be revoked
* @param {string} params.userId email id or unique Id of the user
* @param {().LicenseAssignment} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Licenseassignments$Patch, options?: MethodOptions): GaxiosPromise<Schema$LicenseAssignment>;
patch(params: Params$Resource$Licenseassignments$Patch, options: MethodOptions | BodyResponseCallback<Schema$LicenseAssignment>, callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
patch(params: Params$Resource$Licenseassignments$Patch, callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
patch(callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
/**
* licensing.licenseAssignments.update
* @desc Assign License.
* @alias licensing.licenseAssignments.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.productId Name for product
* @param {string} params.skuId Name for sku for which license would be revoked
* @param {string} params.userId email id or unique Id of the user
* @param {().LicenseAssignment} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Licenseassignments$Update, options?: MethodOptions): GaxiosPromise<Schema$LicenseAssignment>;
update(params: Params$Resource$Licenseassignments$Update, options: MethodOptions | BodyResponseCallback<Schema$LicenseAssignment>, callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
update(params: Params$Resource$Licenseassignments$Update, callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
update(callback: BodyResponseCallback<Schema$LicenseAssignment>): void;
}
interface Params$Resource$Licenseassignments$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name for product
*/
productId?: string;
/**
* Name for sku
*/
skuId?: string;
/**
* email id or unique Id of the user
*/
userId?: string;
}
interface Params$Resource$Licenseassignments$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name for product
*/
productId?: string;
/**
* Name for sku
*/
skuId?: string;
/**
* email id or unique Id of the user
*/
userId?: string;
}
interface Params$Resource$Licenseassignments$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name for product
*/
productId?: string;
/**
* Name for sku
*/
skuId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$LicenseAssignmentInsert;
}
interface Params$Resource$Licenseassignments$Listforproduct extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* CustomerId represents the customer for whom licenseassignments are
* queried
*/
customerId?: string;
/**
* Maximum number of campaigns to return at one time. Must be positive.
* Optional. Default value is 100.
*/
maxResults?: number;
/**
* Token to fetch the next page.Optional. By default server will return
* first page
*/
pageToken?: string;
/**
* Name for product
*/
productId?: string;
}
interface Params$Resource$Licenseassignments$Listforproductandsku extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* CustomerId represents the customer for whom licenseassignments are
* queried
*/
customerId?: string;
/**
* Maximum number of campaigns to return at one time. Must be positive.
* Optional. Default value is 100.
*/
maxResults?: number;
/**
* Token to fetch the next page.Optional. By default server will return
* first page
*/
pageToken?: string;
/**
* Name for product
*/
productId?: string;
/**
* Name for sku
*/
skuId?: string;
}
interface Params$Resource$Licenseassignments$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name for product
*/
productId?: string;
/**
* Name for sku for which license would be revoked
*/
skuId?: string;
/**
* email id or unique Id of the user
*/
userId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$LicenseAssignment;
}
interface Params$Resource$Licenseassignments$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name for product
*/
productId?: string;
/**
* Name for sku for which license would be revoked
*/
skuId?: string;
/**
* email id or unique Id of the user
*/
userId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$LicenseAssignment;
}
}