google-cloud-document_ai-v1 1.11.0 → 1.12.1

data/proto_docs/google/type/date.rb

@@ -24,14 +24,17 @@ module Google
     # date is relative to the Gregorian Calendar. This can represent one of the
     # following:
     #
-    # * A full date, with non-zero year, month, and day values
-    # * A month and day value, with a zero year, such as an anniversary
-    # * A year on its own, with zero month and day values
-    # * A year and month value, with a zero day, such as a credit card expiration
-    # date
+    # * A full date, with non-zero year, month, and day values.
+    # * A month and day, with a zero year (for example, an anniversary).
+    # * A year on its own, with a zero month and a zero day.
+    # * A year and month, with a zero day (for example, a credit card expiration
+    #   date).
     #
-    # Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
-    # `google.protobuf.Timestamp`.
+    # Related types:
+    #
+    # * [google.type.TimeOfDay][google.type.TimeOfDay]
+    # * {::Google::Type::DateTime google.type.DateTime}
+    # * {::Google::Protobuf::Timestamp google.protobuf.Timestamp}
     # @!attribute [rw] year
     #   @return [::Integer]
     #     Year of the date. Must be from 1 to 9999, or 0 to specify a date without

data/proto_docs/google/type/datetime.rb

@@ -32,8 +32,8 @@ module Google
     #
     # The date is relative to the Proleptic Gregorian Calendar.
     #
-    # If year is 0, the DateTime is considered not to have a specific year. month
-    # and day must have valid, non-zero values.
+    # If year, month, or day are 0, the DateTime is considered not to have a
+    # specific year, month, or day respectively.
     #
     # This type may also be used to represent a physical time if all the date and
     # time fields are set and either case of the `time_offset` oneof is set.
@@ -49,27 +49,28 @@ module Google
     #     datetime without a year.
     # @!attribute [rw] month
     #   @return [::Integer]
-    #     Required. Month of year. Must be from 1 to 12.
+    #     Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
+    #     datetime without a month.
     # @!attribute [rw] day
     #   @return [::Integer]
-    #     Required. Day of month. Must be from 1 to 31 and valid for the year and
-    #     month.
+    #     Optional. Day of month. Must be from 1 to 31 and valid for the year and
+    #     month, or 0 if specifying a datetime without a day.
     # @!attribute [rw] hours
     #   @return [::Integer]
-    #     Required. Hours of day in 24 hour format. Should be from 0 to 23. An API
-    #     may choose to allow the value "24:00:00" for scenarios like business
-    #     closing time.
+    #     Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
+    #     to 0 (midnight). An API may choose to allow the value "24:00:00" for
+    #     scenarios like business closing time.
     # @!attribute [rw] minutes
     #   @return [::Integer]
-    #     Required. Minutes of hour of day. Must be from 0 to 59.
+    #     Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
     # @!attribute [rw] seconds
     #   @return [::Integer]
-    #     Required. Seconds of minutes of the time. Must normally be from 0 to 59. An
-    #     API may allow the value 60 if it allows leap-seconds.
+    #     Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
+    #     defaults to 0. An API may allow the value 60 if it allows leap-seconds.
     # @!attribute [rw] nanos
     #   @return [::Integer]
-    #     Required. Fractions of seconds in nanoseconds. Must be from 0 to
-    #     999,999,999.
+    #     Optional. Fractions of seconds in nanoseconds. Must be from 0 to
+    #     999,999,999, defaults to 0.
     # @!attribute [rw] utc_offset
     #   @return [::Google::Protobuf::Duration]
     #     UTC offset. Must be whole seconds, between -18 hours and +18 hours.
@@ -91,10 +92,10 @@ module Google
     # [IANA Time Zone Database](https://www.iana.org/time-zones).
     # @!attribute [rw] id
     #   @return [::String]
-    #     IANA Time Zone Database time zone, e.g. "America/New_York".
+    #     IANA Time Zone Database time zone. For example "America/New_York".
     # @!attribute [rw] version
     #   @return [::String]
-    #     Optional. IANA Time Zone Database version number, e.g. "2019a".
+    #     Optional. IANA Time Zone Database version number. For example "2019a".
     class TimeZone
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/type/postal_address.rb

@@ -19,23 +19,23 @@
 
 module Google
   module Type
-    # Represents a postal address, e.g. for postal delivery or payments addresses.
-    # Given a postal address, a postal service can deliver items to a premise, P.O.
-    # Box or similar.
-    # It is not intended to model geographical locations (roads, towns,
-    # mountains).
+    # Represents a postal address, such as for postal delivery or payments
+    # addresses. With a postal address, a postal service can deliver items to a
+    # premise, P.O. box, or similar. A postal address is not intended to model
+    # geographical locations like roads, towns, or mountains.
     #
-    # In typical usage an address would be created via user input or from importing
+    # In typical usage, an address would be created by user input or from importing
     # existing data, depending on the type of process.
     #
-    # Advice on address input / editing:
-    #  - Use an i18n-ready address widget such as
-    #    https://github.com/google/libaddressinput)
-    # - Users should not be presented with UI elements for input or editing of
-    #   fields outside countries where that field is used.
+    # Advice on address input or editing:
     #
-    # For more guidance on how to use this schema, please see:
-    # https://support.google.com/business/answer/6397478
+    #  - Use an internationalization-ready address widget such as
+    #  https://github.com/google/libaddressinput.
+    #  - Users should not be presented with UI elements for input or editing of
+    #  fields outside countries where that field is used.
+    #
+    # For more guidance on how to use this schema, see:
+    # https://support.google.com/business/answer/6397478.
     # @!attribute [rw] revision
     #   @return [::Integer]
     #     The schema revision of the `PostalAddress`. This must be set to 0, which is
@@ -46,8 +46,8 @@ module Google
     #   @return [::String]
     #     Required. CLDR region code of the country/region of the address. This
     #     is never inferred and it is up to the user to ensure the value is
-    #     correct. See http://cldr.unicode.org/ and
-    #     http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
+    #     correct. See https://cldr.unicode.org/ and
+    #     https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
     #     for details. Example: "CH" for Switzerland.
     # @!attribute [rw] language_code
     #   @return [::String]
@@ -67,55 +67,56 @@ module Google
     #   @return [::String]
     #     Optional. Postal code of the address. Not all countries use or require
     #     postal codes to be present, but where they are used, they may trigger
-    #     additional validation with other parts of the address (e.g. state/zip
-    #     validation in the U.S.A.).
+    #     additional validation with other parts of the address (for example,
+    #     state or zip code validation in the United States).
     # @!attribute [rw] sorting_code
     #   @return [::String]
     #     Optional. Additional, country-specific, sorting code. This is not used
     #     in most regions. Where it is used, the value is either a string like
-    #     "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
-    #     alone, representing the "sector code" (Jamaica), "delivery area indicator"
-    #     (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+    #     "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just
+    #     a number alone, representing the "sector code" (Jamaica), "delivery area
+    #     indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
     # @!attribute [rw] administrative_area
     #   @return [::String]
     #     Optional. Highest administrative subdivision which is used for postal
     #     addresses of a country or region.
     #     For example, this can be a state, a province, an oblast, or a prefecture.
-    #     Specifically, for Spain this is the province and not the autonomous
-    #     community (e.g. "Barcelona" and not "Catalonia").
-    #     Many countries don't use an administrative area in postal addresses. E.g.
-    #     in Switzerland this should be left unpopulated.
+    #     For Spain, this is the province and not the autonomous
+    #     community (for example, "Barcelona" and not "Catalonia").
+    #     Many countries don't use an administrative area in postal addresses. For
+    #     example, in Switzerland, this should be left unpopulated.
     # @!attribute [rw] locality
     #   @return [::String]
-    #     Optional. Generally refers to the city/town portion of the address.
+    #     Optional. Generally refers to the city or town portion of the address.
     #     Examples: US city, IT comune, UK post town.
     #     In regions of the world where localities are not well defined or do not fit
-    #     into this structure well, leave locality empty and use address_lines.
+    #     into this structure well, leave `locality` empty and use `address_lines`.
     # @!attribute [rw] sublocality
     #   @return [::String]
     #     Optional. Sublocality of the address.
-    #     For example, this can be neighborhoods, boroughs, districts.
+    #     For example, this can be a neighborhood, borough, or district.
     # @!attribute [rw] address_lines
     #   @return [::Array<::String>]
     #     Unstructured address lines describing the lower levels of an address.
     #
-    #     Because values in address_lines do not have type information and may
-    #     sometimes contain multiple values in a single field (e.g.
+    #     Because values in `address_lines` do not have type information and may
+    #     sometimes contain multiple values in a single field (for example,
     #     "Austin, TX"), it is important that the line order is clear. The order of
-    #     address lines should be "envelope order" for the country/region of the
-    #     address. In places where this can vary (e.g. Japan), address_language is
-    #     used to make it explicit (e.g. "ja" for large-to-small ordering and
-    #     "ja-Latn" or "en" for small-to-large). This way, the most specific line of
-    #     an address can be selected based on the language.
+    #     address lines should be "envelope order" for the country or region of the
+    #     address. In places where this can vary (for example, Japan),
+    #     `address_language` is used to make it explicit (for example, "ja" for
+    #     large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this
+    #     way, the most specific line of an address can be selected based on the
+    #     language.
     #
     #     The minimum permitted structural representation of an address consists
-    #     of a region_code with all remaining information placed in the
-    #     address_lines. It would be possible to format such an address very
+    #     of a `region_code` with all remaining information placed in the
+    #     `address_lines`. It would be possible to format such an address very
     #     approximately without geocoding, but no semantic reasoning could be
     #     made about any of the address components until it was at least
     #     partially resolved.
     #
-    #     Creating an address only containing a region_code and address_lines, and
+    #     Creating an address only containing a `region_code` and `address_lines` and
     #     then geocoding is the recommended way to handle completely unstructured
     #     addresses (as opposed to guessing which parts of the address should be
     #     localities or administrative areas).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.1
 platform: ruby
 authors:
 - Google LLC
@@ -129,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="