@maxim_mazurok/gapi.client.firebaseappdistribution-v1 0.0.20230410

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.
Files changed (6) hide show
  1. package/index.d.ts +1675 -0
  2. package/package.json +20 -0
  3. package/readme.md +73 -0
  4. package/tests.ts +463 -0
  5. package/tsconfig.json +18 -0
  6. package/tslint.json +6 -0
package/package.json ADDED
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "@maxim_mazurok/gapi.client.firebaseappdistribution-v1",
3
+ "version": "0.0.20230410",
4
+ "description": "TypeScript typings for Firebase App Distribution API v1",
5
+ "license": "MIT",
6
+ "author": {
7
+ "email": "maxim@mazurok.com",
8
+ "name": "Maxim Mazurok",
9
+ "url": "https://maxim.mazurok.com"
10
+ },
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
14
+ },
15
+ "types": "index.d.ts",
16
+ "dependencies": {
17
+ "@types/gapi.client": "*",
18
+ "@types/gapi.client.discovery": "*"
19
+ }
20
+ }
package/readme.md ADDED
@@ -0,0 +1,73 @@
1
+ # TypeScript typings for Firebase App Distribution API v1
2
+
3
+
4
+ For detailed description please check [documentation](https://firebase.google.com/products/app-distribution).
5
+
6
+ ## Installing
7
+
8
+ Install typings for Firebase App Distribution API:
9
+
10
+ ```
11
+ npm install @types/gapi.client.firebaseappdistribution-v1 --save-dev
12
+ ```
13
+
14
+ ## Usage
15
+
16
+ You need to initialize Google API client in your code:
17
+
18
+ ```typescript
19
+ gapi.load('client', () => {
20
+ // now we can use gapi.client
21
+ // ...
22
+ });
23
+ ```
24
+
25
+ Then load api client wrapper:
26
+
27
+ ```typescript
28
+ gapi.client.load('https://firebaseappdistribution.googleapis.com/$discovery/rest?version=v1', () => {
29
+ // now we can use:
30
+ // gapi.client.firebaseappdistribution
31
+ });
32
+ ```
33
+
34
+ ```typescript
35
+ // Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
36
+ gapi.client.load('firebaseappdistribution', 'v1', () => {
37
+ // now we can use:
38
+ // gapi.client.firebaseappdistribution
39
+ });
40
+ ```
41
+
42
+ Don't forget to authenticate your client before sending any request to resources:
43
+
44
+ ```typescript
45
+ // declare client_id registered in Google Developers Console
46
+ var client_id = '',
47
+ scope = [
48
+ // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
49
+ 'https://www.googleapis.com/auth/cloud-platform',
50
+ ],
51
+ immediate = true;
52
+ // ...
53
+
54
+ gapi.auth.authorize(
55
+ { client_id: client_id, scope: scope, immediate: immediate },
56
+ authResult => {
57
+ if (authResult && !authResult.error) {
58
+ /* handle successful authorization */
59
+ } else {
60
+ /* handle authorization error */
61
+ }
62
+ });
63
+ ```
64
+
65
+ After that you can use Firebase App Distribution API resources: <!-- TODO: make this work for multiple namespaces -->
66
+
67
+ ```typescript
68
+
69
+ /*
70
+ Uploads a binary. Uploading a binary can result in a new release being created, an update to an existing release, or a no-op if a release with the same binary already exists.
71
+ */
72
+ await gapi.client.firebaseappdistribution.media.upload({ app: "app", });
73
+ ```
package/tests.ts ADDED
@@ -0,0 +1,463 @@
1
+ /* This is stub file for gapi.client.firebaseappdistribution-v1 definition tests */
2
+ // IMPORTANT
3
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
+
6
+ // Revision: 20230410
7
+
8
+ gapi.load('client', async () => {
9
+ /** now we can use gapi.client */
10
+
11
+ await gapi.client.load('https://firebaseappdistribution.googleapis.com/$discovery/rest?version=v1');
12
+ /** now we can use gapi.client.firebaseappdistribution */
13
+
14
+ /** don't forget to authenticate your client before sending any request to resources: */
15
+ /** declare client_id registered in Google Developers Console */
16
+ const client_id = '<<PUT YOUR CLIENT ID HERE>>';
17
+ const scope = [
18
+ /** See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. */
19
+ 'https://www.googleapis.com/auth/cloud-platform',
20
+ ];
21
+ const immediate = false;
22
+ gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
23
+ if (authResult && !authResult.error) {
24
+ /** handle successful authorization */
25
+ run();
26
+ } else {
27
+ /** handle authorization error */
28
+ }
29
+ });
30
+
31
+ async function run() {
32
+ /** Uploads a binary. Uploading a binary can result in a new release being created, an update to an existing release, or a no-op if a release with the same binary already exists. */
33
+ await gapi.client.firebaseappdistribution.media.upload({
34
+ app: "Test string",
35
+ }, {
36
+ blob: {
37
+ algorithm: "Test string",
38
+ bigstoreObjectRef: "Test string",
39
+ blobRef: "Test string",
40
+ blobstore2Info: {
41
+ blobGeneration: "Test string",
42
+ blobId: "Test string",
43
+ downloadReadHandle: "Test string",
44
+ readToken: "Test string",
45
+ uploadMetadataContainer: "Test string",
46
+ },
47
+ compositeMedia: [
48
+ {
49
+ blobRef: "Test string",
50
+ blobstore2Info: {
51
+ blobGeneration: "Test string",
52
+ blobId: "Test string",
53
+ downloadReadHandle: "Test string",
54
+ readToken: "Test string",
55
+ uploadMetadataContainer: "Test string",
56
+ },
57
+ cosmoBinaryReference: "Test string",
58
+ crc32cHash: 42,
59
+ inline: "Test string",
60
+ length: "Test string",
61
+ md5Hash: "Test string",
62
+ objectId: {
63
+ bucketName: "Test string",
64
+ generation: "Test string",
65
+ objectName: "Test string",
66
+ },
67
+ path: "Test string",
68
+ referenceType: "Test string",
69
+ sha1Hash: "Test string",
70
+ }
71
+ ],
72
+ contentType: "Test string",
73
+ contentTypeInfo: {
74
+ bestGuess: "Test string",
75
+ fromBytes: "Test string",
76
+ fromFileName: "Test string",
77
+ fromHeader: "Test string",
78
+ fromUrlPath: "Test string",
79
+ },
80
+ cosmoBinaryReference: "Test string",
81
+ crc32cHash: 42,
82
+ diffChecksumsResponse: {
83
+ checksumsLocation: {
84
+ blobRef: "Test string",
85
+ blobstore2Info: {
86
+ blobGeneration: "Test string",
87
+ blobId: "Test string",
88
+ downloadReadHandle: "Test string",
89
+ readToken: "Test string",
90
+ uploadMetadataContainer: "Test string",
91
+ },
92
+ cosmoBinaryReference: "Test string",
93
+ crc32cHash: 42,
94
+ inline: "Test string",
95
+ length: "Test string",
96
+ md5Hash: "Test string",
97
+ objectId: {
98
+ bucketName: "Test string",
99
+ generation: "Test string",
100
+ objectName: "Test string",
101
+ },
102
+ path: "Test string",
103
+ referenceType: "Test string",
104
+ sha1Hash: "Test string",
105
+ },
106
+ chunkSizeBytes: "Test string",
107
+ objectLocation: {
108
+ blobRef: "Test string",
109
+ blobstore2Info: {
110
+ blobGeneration: "Test string",
111
+ blobId: "Test string",
112
+ downloadReadHandle: "Test string",
113
+ readToken: "Test string",
114
+ uploadMetadataContainer: "Test string",
115
+ },
116
+ cosmoBinaryReference: "Test string",
117
+ crc32cHash: 42,
118
+ inline: "Test string",
119
+ length: "Test string",
120
+ md5Hash: "Test string",
121
+ objectId: {
122
+ bucketName: "Test string",
123
+ generation: "Test string",
124
+ objectName: "Test string",
125
+ },
126
+ path: "Test string",
127
+ referenceType: "Test string",
128
+ sha1Hash: "Test string",
129
+ },
130
+ objectSizeBytes: "Test string",
131
+ objectVersion: "Test string",
132
+ },
133
+ diffDownloadResponse: {
134
+ objectLocation: {
135
+ blobRef: "Test string",
136
+ blobstore2Info: {
137
+ blobGeneration: "Test string",
138
+ blobId: "Test string",
139
+ downloadReadHandle: "Test string",
140
+ readToken: "Test string",
141
+ uploadMetadataContainer: "Test string",
142
+ },
143
+ cosmoBinaryReference: "Test string",
144
+ crc32cHash: 42,
145
+ inline: "Test string",
146
+ length: "Test string",
147
+ md5Hash: "Test string",
148
+ objectId: {
149
+ bucketName: "Test string",
150
+ generation: "Test string",
151
+ objectName: "Test string",
152
+ },
153
+ path: "Test string",
154
+ referenceType: "Test string",
155
+ sha1Hash: "Test string",
156
+ },
157
+ },
158
+ diffUploadRequest: {
159
+ checksumsInfo: {
160
+ blobRef: "Test string",
161
+ blobstore2Info: {
162
+ blobGeneration: "Test string",
163
+ blobId: "Test string",
164
+ downloadReadHandle: "Test string",
165
+ readToken: "Test string",
166
+ uploadMetadataContainer: "Test string",
167
+ },
168
+ cosmoBinaryReference: "Test string",
169
+ crc32cHash: 42,
170
+ inline: "Test string",
171
+ length: "Test string",
172
+ md5Hash: "Test string",
173
+ objectId: {
174
+ bucketName: "Test string",
175
+ generation: "Test string",
176
+ objectName: "Test string",
177
+ },
178
+ path: "Test string",
179
+ referenceType: "Test string",
180
+ sha1Hash: "Test string",
181
+ },
182
+ objectInfo: {
183
+ blobRef: "Test string",
184
+ blobstore2Info: {
185
+ blobGeneration: "Test string",
186
+ blobId: "Test string",
187
+ downloadReadHandle: "Test string",
188
+ readToken: "Test string",
189
+ uploadMetadataContainer: "Test string",
190
+ },
191
+ cosmoBinaryReference: "Test string",
192
+ crc32cHash: 42,
193
+ inline: "Test string",
194
+ length: "Test string",
195
+ md5Hash: "Test string",
196
+ objectId: {
197
+ bucketName: "Test string",
198
+ generation: "Test string",
199
+ objectName: "Test string",
200
+ },
201
+ path: "Test string",
202
+ referenceType: "Test string",
203
+ sha1Hash: "Test string",
204
+ },
205
+ objectVersion: "Test string",
206
+ },
207
+ diffUploadResponse: {
208
+ objectVersion: "Test string",
209
+ originalObject: {
210
+ blobRef: "Test string",
211
+ blobstore2Info: {
212
+ blobGeneration: "Test string",
213
+ blobId: "Test string",
214
+ downloadReadHandle: "Test string",
215
+ readToken: "Test string",
216
+ uploadMetadataContainer: "Test string",
217
+ },
218
+ cosmoBinaryReference: "Test string",
219
+ crc32cHash: 42,
220
+ inline: "Test string",
221
+ length: "Test string",
222
+ md5Hash: "Test string",
223
+ objectId: {
224
+ bucketName: "Test string",
225
+ generation: "Test string",
226
+ objectName: "Test string",
227
+ },
228
+ path: "Test string",
229
+ referenceType: "Test string",
230
+ sha1Hash: "Test string",
231
+ },
232
+ },
233
+ diffVersionResponse: {
234
+ objectSizeBytes: "Test string",
235
+ objectVersion: "Test string",
236
+ },
237
+ downloadParameters: {
238
+ allowGzipCompression: true,
239
+ ignoreRange: true,
240
+ },
241
+ filename: "Test string",
242
+ hash: "Test string",
243
+ hashVerified: true,
244
+ inline: "Test string",
245
+ isPotentialRetry: true,
246
+ length: "Test string",
247
+ md5Hash: "Test string",
248
+ mediaId: "Test string",
249
+ objectId: {
250
+ bucketName: "Test string",
251
+ generation: "Test string",
252
+ objectName: "Test string",
253
+ },
254
+ path: "Test string",
255
+ referenceType: "Test string",
256
+ sha1Hash: "Test string",
257
+ sha256Hash: "Test string",
258
+ timestamp: "Test string",
259
+ token: "Test string",
260
+ },
261
+ });
262
+ /** Gets Android App Bundle (AAB) information for a Firebase app. */
263
+ await gapi.client.firebaseappdistribution.projects.apps.getAabInfo({
264
+ name: "Test string",
265
+ });
266
+ /** Deletes releases. A maximum of 100 releases can be deleted per request. */
267
+ await gapi.client.firebaseappdistribution.projects.apps.releases.batchDelete({
268
+ parent: "Test string",
269
+ }, {
270
+ names: [
271
+ "Test string"
272
+ ],
273
+ });
274
+ /**
275
+ * Distributes a release to testers. This call does the following: 1. Creates testers for the specified emails, if none exist. 2. Adds the testers and groups to the release. 3. Sends new
276
+ * testers an invitation email. 4. Sends existing testers a new release email. The request will fail with a `INVALID_ARGUMENT` if it contains a group that doesn't exist.
277
+ */
278
+ await gapi.client.firebaseappdistribution.projects.apps.releases.distribute({
279
+ name: "Test string",
280
+ }, {
281
+ groupAliases: [
282
+ "Test string"
283
+ ],
284
+ testerEmails: [
285
+ "Test string"
286
+ ],
287
+ });
288
+ /** Gets a release. */
289
+ await gapi.client.firebaseappdistribution.projects.apps.releases.get({
290
+ name: "Test string",
291
+ });
292
+ /** Lists releases. By default, sorts by `createTime` in descending order. */
293
+ await gapi.client.firebaseappdistribution.projects.apps.releases.list({
294
+ filter: "Test string",
295
+ orderBy: "Test string",
296
+ pageSize: 42,
297
+ pageToken: "Test string",
298
+ parent: "Test string",
299
+ });
300
+ /** Updates a release. */
301
+ await gapi.client.firebaseappdistribution.projects.apps.releases.patch({
302
+ name: "Test string",
303
+ updateMask: "Test string",
304
+ }, {
305
+ binaryDownloadUri: "Test string",
306
+ buildVersion: "Test string",
307
+ createTime: "Test string",
308
+ displayVersion: "Test string",
309
+ firebaseConsoleUri: "Test string",
310
+ name: "Test string",
311
+ releaseNotes: {
312
+ text: "Test string",
313
+ },
314
+ testingUri: "Test string",
315
+ });
316
+ /** Deletes a feedback report. */
317
+ await gapi.client.firebaseappdistribution.projects.apps.releases.feedbackReports.delete({
318
+ name: "Test string",
319
+ });
320
+ /** Gets a feedback report. */
321
+ await gapi.client.firebaseappdistribution.projects.apps.releases.feedbackReports.get({
322
+ name: "Test string",
323
+ });
324
+ /** Lists feedback reports. By default, sorts by `createTime` in descending order. */
325
+ await gapi.client.firebaseappdistribution.projects.apps.releases.feedbackReports.list({
326
+ filter: "Test string",
327
+ orderBy: "Test string",
328
+ pageSize: 42,
329
+ pageToken: "Test string",
330
+ parent: "Test string",
331
+ });
332
+ /**
333
+ * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this
334
+ * method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation
335
+ * completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of
336
+ * 1, corresponding to `Code.CANCELLED`.
337
+ */
338
+ await gapi.client.firebaseappdistribution.projects.apps.releases.operations.cancel({
339
+ name: "Test string",
340
+ }, {
341
+ });
342
+ /**
343
+ * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support
344
+ * this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
345
+ */
346
+ await gapi.client.firebaseappdistribution.projects.apps.releases.operations.delete({
347
+ name: "Test string",
348
+ });
349
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
350
+ await gapi.client.firebaseappdistribution.projects.apps.releases.operations.get({
351
+ name: "Test string",
352
+ });
353
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
354
+ await gapi.client.firebaseappdistribution.projects.apps.releases.operations.list({
355
+ filter: "Test string",
356
+ name: "Test string",
357
+ pageSize: 42,
358
+ pageToken: "Test string",
359
+ });
360
+ /**
361
+ * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is
362
+ * immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns
363
+ * `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an
364
+ * immediate response is no guarantee that the operation is done.
365
+ */
366
+ await gapi.client.firebaseappdistribution.projects.apps.releases.operations.wait({
367
+ name: "Test string",
368
+ }, {
369
+ timeout: "Test string",
370
+ });
371
+ /** Batch adds members to a group. The testers will gain access to all releases that the groups have access to. */
372
+ await gapi.client.firebaseappdistribution.projects.groups.batchJoin({
373
+ group: "Test string",
374
+ }, {
375
+ createMissingTesters: true,
376
+ emails: [
377
+ "Test string"
378
+ ],
379
+ });
380
+ /** Batch removed members from a group. The testers will lose access to all releases that the groups have access to. */
381
+ await gapi.client.firebaseappdistribution.projects.groups.batchLeave({
382
+ group: "Test string",
383
+ }, {
384
+ emails: [
385
+ "Test string"
386
+ ],
387
+ });
388
+ /** Create a group. */
389
+ await gapi.client.firebaseappdistribution.projects.groups.create({
390
+ groupId: "Test string",
391
+ parent: "Test string",
392
+ }, {
393
+ displayName: "Test string",
394
+ inviteLinkCount: 42,
395
+ name: "Test string",
396
+ releaseCount: 42,
397
+ testerCount: 42,
398
+ });
399
+ /** Delete a group. */
400
+ await gapi.client.firebaseappdistribution.projects.groups.delete({
401
+ name: "Test string",
402
+ });
403
+ /** Get a group. */
404
+ await gapi.client.firebaseappdistribution.projects.groups.get({
405
+ name: "Test string",
406
+ });
407
+ /** List groups. */
408
+ await gapi.client.firebaseappdistribution.projects.groups.list({
409
+ pageSize: 42,
410
+ pageToken: "Test string",
411
+ parent: "Test string",
412
+ });
413
+ /** Update a group. */
414
+ await gapi.client.firebaseappdistribution.projects.groups.patch({
415
+ name: "Test string",
416
+ updateMask: "Test string",
417
+ }, {
418
+ displayName: "Test string",
419
+ inviteLinkCount: 42,
420
+ name: "Test string",
421
+ releaseCount: 42,
422
+ testerCount: 42,
423
+ });
424
+ /**
425
+ * Batch adds testers. This call adds testers for the specified emails if they don't already exist. Returns all testers specified in the request, including newly created and previously
426
+ * existing testers. This action is idempotent.
427
+ */
428
+ await gapi.client.firebaseappdistribution.projects.testers.batchAdd({
429
+ project: "Test string",
430
+ }, {
431
+ emails: [
432
+ "Test string"
433
+ ],
434
+ });
435
+ /** Batch removes testers. If found, this call deletes testers for the specified emails. Returns all deleted testers. */
436
+ await gapi.client.firebaseappdistribution.projects.testers.batchRemove({
437
+ project: "Test string",
438
+ }, {
439
+ emails: [
440
+ "Test string"
441
+ ],
442
+ });
443
+ /** Lists testers and their resource ids. */
444
+ await gapi.client.firebaseappdistribution.projects.testers.list({
445
+ filter: "Test string",
446
+ pageSize: 42,
447
+ pageToken: "Test string",
448
+ parent: "Test string",
449
+ });
450
+ /** Update a tester. If the testers joins a group they gain access to all releases that the group has access to. */
451
+ await gapi.client.firebaseappdistribution.projects.testers.patch({
452
+ name: "Test string",
453
+ updateMask: "Test string",
454
+ }, {
455
+ displayName: "Test string",
456
+ groups: [
457
+ "Test string"
458
+ ],
459
+ lastActivityTime: "Test string",
460
+ name: "Test string",
461
+ });
462
+ }
463
+ });
package/tsconfig.json ADDED
@@ -0,0 +1,18 @@
1
+ {
2
+ "compilerOptions": {
3
+ "module": "commonjs",
4
+ "lib": ["es6", "dom"],
5
+ "noImplicitAny": true,
6
+ "noImplicitThis": true,
7
+ "strictNullChecks": true,
8
+ "baseUrl": "../",
9
+ "typeRoots": [
10
+ "../"
11
+ ],
12
+ "types": [],
13
+ "noEmit": true,
14
+ "forceConsistentCasingInFileNames": true,
15
+ "strictFunctionTypes": true
16
+ },
17
+ "files": ["index.d.ts", "tests.ts"]
18
+ }
package/tslint.json ADDED
@@ -0,0 +1,6 @@
1
+ {
2
+ "extends": "dtslint/dtslint.json",
3
+ "rules": {
4
+ "no-redundant-jsdoc": false
5
+ }
6
+ }