@maxim_mazurok/gapi.client.videointelligence-v1beta2 0.0.20220303

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.videointelligence-v1beta2",
+  "version": "0.0.20220303",
+  "description": "TypeScript typings for Cloud Video Intelligence API v1beta2",
+  "license": "MIT",
+  "author": {
+    "email": "maxim@mazurok.com",
+    "name": "Maxim Mazurok",
+    "url": "https://maxim.mazurok.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,73 @@
+# TypeScript typings for Cloud Video Intelligence API v1beta2
+
+Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.
+For detailed description please check [documentation](https://cloud.google.com/video-intelligence/docs/).
+
+## Installing
+
+Install typings for Cloud Video Intelligence API:
+
+```
+npm install @types/gapi.client.videointelligence-v1beta2 --save-dev
+```
+
+## Usage
+
+You need to initialize Google API client in your code:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load('https://videointelligence.googleapis.com/$discovery/rest?version=v1beta2', () => {
+  // now we can use:
+  // gapi.client.videointelligence
+});
+```
+
+```typescript
+// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
+gapi.client.load('videointelligence', 'v1beta2', () => {
+  // now we can use:
+  // gapi.client.videointelligence
+});
+```
+
+Don't forget to authenticate your client before sending any request to resources:
+
+```typescript
+// declare client_id registered in Google Developers Console
+var client_id = '',
+  scope = [
+      // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
+      'https://www.googleapis.com/auth/cloud-platform',
+    ],
+    immediate = true;
+// ...
+
+gapi.auth.authorize(
+  { client_id: client_id, scope: scope, immediate: immediate },
+  authResult => {
+    if (authResult && !authResult.error) {
+        /* handle successful authorization */
+    } else {
+        /* handle authorization error */
+    }
+});
+```
+
+After that you can use Cloud Video Intelligence API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Performs asynchronous video annotation. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `AnnotateVideoProgress` (progress). `Operation.response` contains `AnnotateVideoResponse` (results).
+*/
+await gapi.client.videointelligence.videos.annotate({  });
+```

package/tests.ts

@@ -0,0 +1,106 @@
+/* This is stub file for gapi.client.videointelligence-v1beta2 definition tests */
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+
+// Revision: 20220303
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://videointelligence.googleapis.com/$discovery/rest?version=v1beta2');
+    /** now we can use gapi.client.videointelligence */
+
+    /** don't forget to authenticate your client before sending any request to resources: */
+    /** declare client_id registered in Google Developers Console */
+    const client_id = '<<PUT YOUR CLIENT ID HERE>>';
+    const scope = [
+        /** See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. */
+        'https://www.googleapis.com/auth/cloud-platform',
+    ];
+    const immediate = false;
+    gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
+        if (authResult && !authResult.error) {
+            /** handle successful authorization */
+            run();
+        } else {
+            /** handle authorization error */
+        }
+    });
+
+    async function run() {
+        /**
+         * Performs asynchronous video annotation. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains
+         * `AnnotateVideoProgress` (progress). `Operation.response` contains `AnnotateVideoResponse` (results).
+         */
+        await gapi.client.videointelligence.videos.annotate({
+        }, {
+            features: [
+                "Test string"
+            ],
+            inputContent: "Test string",
+            inputUri: "Test string",
+            locationId: "Test string",
+            outputUri: "Test string",
+            videoContext: {
+                explicitContentDetectionConfig: {
+                    model: "Test string",
+                },
+                faceDetectionConfig: {
+                    includeAttributes: true,
+                    includeBoundingBoxes: true,
+                    model: "Test string",
+                },
+                labelDetectionConfig: {
+                    frameConfidenceThreshold: 42,
+                    labelDetectionMode: "Test string",
+                    model: "Test string",
+                    stationaryCamera: true,
+                    videoConfidenceThreshold: 42,
+                },
+                objectTrackingConfig: {
+                    model: "Test string",
+                },
+                personDetectionConfig: {
+                    includeAttributes: true,
+                    includeBoundingBoxes: true,
+                    includePoseLandmarks: true,
+                },
+                segments: [
+                    {
+                        endTimeOffset: "Test string",
+                        startTimeOffset: "Test string",
+                    }
+                ],
+                shotChangeDetectionConfig: {
+                    model: "Test string",
+                },
+                speechTranscriptionConfig: {
+                    audioTracks: [
+                        42
+                    ],
+                    diarizationSpeakerCount: 42,
+                    enableAutomaticPunctuation: true,
+                    enableSpeakerDiarization: true,
+                    enableWordConfidence: true,
+                    filterProfanity: true,
+                    languageCode: "Test string",
+                    maxAlternatives: 42,
+                    speechContexts: [
+                        {
+                            phrases: [
+                                "Test string"
+                            ],
+                        }
+                    ],
+                },
+                textDetectionConfig: {
+                    languageHints: [
+                        "Test string"
+                    ],
+                    model: "Test string",
+                },
+            },
+        });
+    }
+});

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6", "dom"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "strictFunctionTypes": true
+    },
+    "files": ["index.d.ts", "tests.ts"]
+}

package/tslint.json

@@ -0,0 +1,6 @@
+{
+    "extends": "dtslint/dtslint.json",
+    "rules": {
+        "no-redundant-jsdoc": false
+    }
+}