@maxim_mazurok/gapi.client.documentai-v1 0.0.20230526 → 0.0.20230609

package/index.d.ts

@@ -9,7 +9,7 @@
 // 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
 // Generated from: https://documentai.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230526
+// Revision: 20230609
 
 /// <reference types="gapi.client" />
 
@@ -148,7 +148,7 @@ declare namespace gapi.client {
         interface GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse {
         }
         interface GoogleCloudDocumentaiUiv1beta3DocumentId {
-            /** A document id within user managed Cloud Storage. */
+            /** A document id within user-managed Cloud Storage. */
             gcsManagedDocId?:
                 GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId;
             /** Points to a specific revision of the document if set. */
@@ -162,7 +162,7 @@ declare namespace gapi.client {
             /** Id of the document (indexed) managed by Content Warehouse. */
             cwDocId?:
                 string;
-            /** Required. The Cloud Storage uri where the actual document is stored. */
+            /** Required. The Cloud Storage URI where the actual document is stored. */
             gcsUri?:
                 string;
         }
@@ -466,7 +466,7 @@ declare namespace gapi.client {
             /** The input documents for the BatchProcessDocuments method. */
             inputDocuments?:
                 GoogleCloudDocumentaiV1BatchDocumentsInputConfig;
-            /** Whether Human Review feature should be skipped for this request. Default to false. */
+            /** Whether human review should be skipped for this request. Default to `false`. */
             skipHumanReview?:
                 boolean;
         }
@@ -521,7 +521,7 @@ declare namespace gapi.client {
             /** Any error that occurred while processing this document. */
             error?:
                 GoogleRpcStatus;
-            /** An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. */
+            /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
             mimeType?:
                 string;
             /** Visual page layout for the Document. */
@@ -651,7 +651,7 @@ declare namespace gapi.client {
             /** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
             image?:
                 GoogleCloudDocumentaiV1beta1DocumentPageImage;
-            /** Image Quality Scores. */
+            /** Image quality scores. */
             imageQualityScores?:
                 GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores;
             /** Layout for the page. */
@@ -733,7 +733,7 @@ declare namespace gapi.client {
             /** Confidence of detected language. Range `[0, 1]`. */
             confidence?:
                 number;
-            /** The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
+            /** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
             languageCode?:
                 string;
         }
@@ -784,7 +784,7 @@ declare namespace gapi.client {
             /** Height of the image in pixels. */
             height?:
                 number;
-            /** Encoding mime type for the image. */
+            /** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
             mimeType?:
                 string;
             /** Width of the image in pixels. */
@@ -795,12 +795,12 @@ declare namespace gapi.client {
             /** A list of detected defects. */
             detectedDefects?:
                 GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect[];
-            /** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
+            /** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
             qualityScore?:
                 number;
         }
         interface GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect {
-            /** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
+            /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
             confidence?:
                 number;
             /**
@@ -1073,16 +1073,16 @@ declare namespace gapi.client {
             /** Font size. */
             fontSize?:
                 GoogleCloudDocumentaiV1beta1DocumentStyleFontSize;
-            /** Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp */
+            /** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
             fontWeight?:
                 string;
             /** Text anchor indexing into the Document.text. */
             textAnchor?:
                 GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
-            /** Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp */
+            /** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
             textDecoration?:
                 string;
-            /** Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp */
+            /** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
             textStyle?:
                 string;
         }
@@ -1090,7 +1090,7 @@ declare namespace gapi.client {
             /** Font size for the text. */
             size?:
                 number;
-            /** Unit for the font size. Follows CSS naming (in, px, pt, etc.). */
+            /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
             unit?:
                 string;
         }
@@ -1245,7 +1245,7 @@ declare namespace gapi.client {
             /** Labels for this document. */
             labels?:
                 GoogleCloudDocumentaiV1beta2DocumentLabel[];
-            /** An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. */
+            /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
             mimeType?:
                 string;
             /** Visual page layout for the Document. */
@@ -1386,7 +1386,7 @@ declare namespace gapi.client {
             /** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
             image?:
                 GoogleCloudDocumentaiV1beta2DocumentPageImage;
-            /** Image Quality Scores. */
+            /** Image quality scores. */
             imageQualityScores?:
                 GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores;
             /** Layout for the page. */
@@ -1468,7 +1468,7 @@ declare namespace gapi.client {
             /** Confidence of detected language. Range `[0, 1]`. */
             confidence?:
                 number;
-            /** The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
+            /** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
             languageCode?:
                 string;
         }
@@ -1519,7 +1519,7 @@ declare namespace gapi.client {
             /** Height of the image in pixels. */
             height?:
                 number;
-            /** Encoding mime type for the image. */
+            /** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
             mimeType?:
                 string;
             /** Width of the image in pixels. */
@@ -1530,12 +1530,12 @@ declare namespace gapi.client {
             /** A list of detected defects. */
             detectedDefects?:
                 GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect[];
-            /** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
+            /** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
             qualityScore?:
                 number;
         }
         interface GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect {
-            /** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
+            /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
             confidence?:
                 number;
             /**
@@ -1808,16 +1808,16 @@ declare namespace gapi.client {
             /** Font size. */
             fontSize?:
                 GoogleCloudDocumentaiV1beta2DocumentStyleFontSize;
-            /** Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp */
+            /** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
             fontWeight?:
                 string;
             /** Text anchor indexing into the Document.text. */
             textAnchor?:
                 GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
-            /** Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp */
+            /** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
             textDecoration?:
                 string;
-            /** Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp */
+            /** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
             textStyle?:
                 string;
         }
@@ -1825,7 +1825,7 @@ declare namespace gapi.client {
             /** Font size for the text. */
             size?:
                 number;
-            /** Unit for the font size. Follows CSS naming (in, px, pt, etc.). */
+            /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
             unit?:
                 string;
         }
@@ -2210,7 +2210,7 @@ declare namespace gapi.client {
             /** Any error that occurred while processing this document. */
             error?:
                 GoogleRpcStatus;
-            /** An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. */
+            /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
             mimeType?:
                 string;
             /** Visual page layout for the Document. */
@@ -2367,7 +2367,7 @@ declare namespace gapi.client {
             /** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
             image?:
                 GoogleCloudDocumentaiV1DocumentPageImage;
-            /** Image Quality Scores. */
+            /** Image quality scores. */
             imageQualityScores?:
                 GoogleCloudDocumentaiV1DocumentPageImageQualityScores;
             /** Layout for the page. */
@@ -2449,7 +2449,7 @@ declare namespace gapi.client {
             /** Confidence of detected language. Range `[0, 1]`. */
             confidence?:
                 number;
-            /** The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
+            /** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
             languageCode?:
                 string;
         }
@@ -2500,7 +2500,7 @@ declare namespace gapi.client {
             /** Height of the image in pixels. */
             height?:
                 number;
-            /** Encoding mime type for the image. */
+            /** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
             mimeType?:
                 string;
             /** Width of the image in pixels. */
@@ -2511,12 +2511,12 @@ declare namespace gapi.client {
             /** A list of detected defects. */
             detectedDefects?:
                 GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect[];
-            /** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
+            /** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
             qualityScore?:
                 number;
         }
         interface GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect {
-            /** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
+            /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
             confidence?:
                 number;
             /**
@@ -2793,10 +2793,10 @@ declare namespace gapi.client {
             enumValues?:
                 GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues;
             /**
-             * Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use `snake_casing`* - name
-             * matching is case-sensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure
-             * and tooling can handle any ascii character) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still
-             * be honored for backward compatibility.
+             * Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is
+             * case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and
+             * tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be
+             * honored for backward compatibility.
              */
             name?:
                 string;
@@ -2824,7 +2824,7 @@ declare namespace gapi.client {
             /** If true, on a given page, there can be multiple `document` annotations covering it. */
             documentAllowMultipleLabels?:
                 boolean;
-            /** If true, a `document` entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification). */
+            /** If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */
             documentSplitter?:
                 boolean;
             /** If set, all the nested entities must be prefixed with the parents. */
@@ -2861,16 +2861,16 @@ declare namespace gapi.client {
             /** Font size. */
             fontSize?:
                 GoogleCloudDocumentaiV1DocumentStyleFontSize;
-            /** Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp */
+            /** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
             fontWeight?:
                 string;
             /** Text anchor indexing into the Document.text. */
             textAnchor?:
                 GoogleCloudDocumentaiV1DocumentTextAnchor;
-            /** Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp */
+            /** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
             textDecoration?:
                 string;
-            /** Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp */
+            /** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
             textStyle?:
                 string;
         }
@@ -2878,7 +2878,7 @@ declare namespace gapi.client {
             /** Font size for the text. */
             size?:
                 number;
-            /** Unit for the font size. Follows CSS naming (in, px, pt, etc.). */
+            /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
             unit?:
                 string;
         }
@@ -3142,7 +3142,7 @@ declare namespace gapi.client {
             /** The display name of the processor. */
             displayName?:
                 string;
-            /** The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management. */
+            /** The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */
             kmsKeyName?:
                 string;
             /** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
@@ -3182,7 +3182,7 @@ declare namespace gapi.client {
                 string;
         }
         interface GoogleCloudDocumentaiV1ProcessorTypeLocationInfo {
-            /** The location id, currently must be one of [us, eu]. */
+            /** The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions). */
             locationId?:
                 string;
         }
@@ -3199,7 +3199,7 @@ declare namespace gapi.client {
             /** The schema of the processor version. Describes the output. */
             documentSchema?:
                 GoogleCloudDocumentaiV1DocumentSchema;
-            /** Denotes that this ProcessorVersion is managed by google. */
+            /** Denotes that this `ProcessorVersion` is managed by Google. */
             googleManaged?:
                 boolean;
             /** The KMS key name used for encryption. */
@@ -3239,7 +3239,7 @@ declare namespace gapi.client {
             /** A raw document content (bytes). */
             rawDocument?:
                 GoogleCloudDocumentaiV1RawDocument;
-            /** Whether Human Review feature should be skipped for this request. Default to false. */
+            /** Whether human review should be skipped for this request. Default to `false`. */
             skipHumanReview?:
                 boolean;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.documentai-v1",
-  "version": "0.0.20230526",
+  "version": "0.0.20230609",
   "description": "TypeScript typings for Cloud Document AI API v1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // 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: 20230526
+// Revision: 20230609
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */