google-apis-firestore_v1beta1 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f41c5f8cb2c4352501f3979b11a74771fff7ce61dc33efc40b5e6a55121b104
-  data.tar.gz: 2467620fc50ab37f19d50be286dfd5d15a369d0e5fe5ad6c3f2bed88f0aa6c04
+  metadata.gz: d8ba687051a8226f1ef1aaaa0deb4a607c4781d43e13c0e065b9e7aa287c6287
+  data.tar.gz: 79ec87d5b4c7b0720339d88144e651fad2cd4b68c9d6aaf3613f899274a9b354
 SHA512:
-  metadata.gz: 0cf6e7869ca48623402f927fc4ec4634c9743841602cfbea6848f856df88fd3c12b1c999ba6fc1f85056fab575cf70b0073726521e44aea43dfa0a15150fed4c
-  data.tar.gz: aeb0863420c8645f3ac937812322feded589bd443b8aa255f98be3c9e37c157fcb64d1b5d83c7af98fee36f39bfc10056ae03cd59a1e0877a6292539c04136ce
+  metadata.gz: 42052b1e3e1de9231ed89923993a6566d6e0fc46c764bb7a5bf1d3131d6c42eba3ec8208c1ba54453a6589708604d4c9f037d031c8d1b1ff30c1ecaff3e91880
+  data.tar.gz: '0728aba3b63351f6ebee658a7f59902c2e0475929791137e4dc595435c3526c7be4f832d6284444278f6a3d667d0f076839f134e0ff405c7e097a7823b168750'

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-firestore_v1beta1
 
+### v0.24.0 (2023-02-26)
+
+* Regenerated from discovery document revision 20230214
+* Regenerated using generator version 0.12.0
+
+### v0.23.0 (2022-12-19)
+
+* Regenerated from discovery document revision 20221210
+
 ### v0.22.0 (2022-10-28)
 
 * Regenerated using generator version 0.11.0

data/lib/google/apis/firestore_v1beta1/classes.rb

@@ -1401,7 +1401,8 @@ module Google
         # @return [Array<Google::Apis::FirestoreV1beta1::Document>]
         attr_accessor :documents
       
-        # The next page token.
+        # A token to retrieve the next page of documents. If this field is omitted,
+        # there are no subsequent pages.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token

data/lib/google/apis/firestore_v1beta1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FirestoreV1beta1
       # Version of the google-apis-firestore_v1beta1 gem
-      GEM_VERSION = "0.22.0"
+      GEM_VERSION = "0.24.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.11.0"
+      GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220915"
+      REVISION = "20230214"
     end
   end
 end

data/lib/google/apis/firestore_v1beta1/service.rb

@@ -405,28 +405,35 @@ module Google
         #   databases/my-database/documents` or `projects/my-project/databases/my-database/
         #   documents/chatrooms/my-chatroom`
         # @param [String] collection_id
-        #   Required. The collection ID, relative to `parent`, to list. For example: `
-        #   chatrooms` or `messages`.
+        #   Optional. The collection ID, relative to `parent`, to list. For example: `
+        #   chatrooms` or `messages`. This is optional, and when not provided, Firestore
+        #   will list documents from all collections under the provided `parent`.
         # @param [Array<String>, String] mask_field_paths
         #   The list of field paths in the mask. See Document.fields for a field path
         #   syntax reference.
         # @param [String] order_by
-        #   The order to sort results by. For example: `priority desc, name`.
+        #   Optional. The optional ordering of the documents to return. For example: `
+        #   priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore
+        #   queries but in a string representation. When absent, documents are ordered
+        #   based on `__name__ ASC`.
         # @param [Fixnum] page_size
-        #   The maximum number of documents to return.
+        #   Optional. The maximum number of documents to return in a single response.
+        #   Firestore may return fewer than this value.
         # @param [String] page_token
-        #   The `next_page_token` value returned from a previous List request, if any.
+        #   Optional. A page token, received from a previous `ListDocuments` response.
+        #   Provide this to retrieve the subsequent page. When paginating, all other
+        #   parameters (with the exception of `page_size`) must match the values set in
+        #   the request that generated the page token.
         # @param [String] read_time
-        #   Reads documents as they were at the given time. This may not be older than 270
-        #   seconds.
+        #   Perform the read at the provided time. This may not be older than 270 seconds.
         # @param [Boolean] show_missing
-        #   If the list should show missing documents. A missing document is a document
-        #   that does not exist but has sub-documents. These documents will be returned
-        #   with a key but will not have fields, Document.create_time, or Document.
-        #   update_time set. Requests with `show_missing` may not specify `where` or `
-        #   order_by`.
+        #   If the list should show missing documents. A document is missing if it does
+        #   not exist, but there are sub-documents nested underneath it. When true, such
+        #   missing documents will be returned with a key but will not have fields, `
+        #   create_time`, or `update_time` set. Requests with `show_missing` may not
+        #   specify `where` or `order_by`.
         # @param [String] transaction
-        #   Reads documents in a transaction.
+        #   Perform the read as part of an already active transaction.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -505,28 +512,35 @@ module Google
         #   databases/my-database/documents` or `projects/my-project/databases/my-database/
         #   documents/chatrooms/my-chatroom`
         # @param [String] collection_id
-        #   Required. The collection ID, relative to `parent`, to list. For example: `
-        #   chatrooms` or `messages`.
+        #   Optional. The collection ID, relative to `parent`, to list. For example: `
+        #   chatrooms` or `messages`. This is optional, and when not provided, Firestore
+        #   will list documents from all collections under the provided `parent`.
         # @param [Array<String>, String] mask_field_paths
         #   The list of field paths in the mask. See Document.fields for a field path
         #   syntax reference.
         # @param [String] order_by
-        #   The order to sort results by. For example: `priority desc, name`.
+        #   Optional. The optional ordering of the documents to return. For example: `
+        #   priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore
+        #   queries but in a string representation. When absent, documents are ordered
+        #   based on `__name__ ASC`.
         # @param [Fixnum] page_size
-        #   The maximum number of documents to return.
+        #   Optional. The maximum number of documents to return in a single response.
+        #   Firestore may return fewer than this value.
         # @param [String] page_token
-        #   The `next_page_token` value returned from a previous List request, if any.
+        #   Optional. A page token, received from a previous `ListDocuments` response.
+        #   Provide this to retrieve the subsequent page. When paginating, all other
+        #   parameters (with the exception of `page_size`) must match the values set in
+        #   the request that generated the page token.
         # @param [String] read_time
-        #   Reads documents as they were at the given time. This may not be older than 270
-        #   seconds.
+        #   Perform the read at the provided time. This may not be older than 270 seconds.
         # @param [Boolean] show_missing
-        #   If the list should show missing documents. A missing document is a document
-        #   that does not exist but has sub-documents. These documents will be returned
-        #   with a key but will not have fields, Document.create_time, or Document.
-        #   update_time set. Requests with `show_missing` may not specify `where` or `
-        #   order_by`.
+        #   If the list should show missing documents. A document is missing if it does
+        #   not exist, but there are sub-documents nested underneath it. When true, such
+        #   missing documents will be returned with a key but will not have fields, `
+        #   create_time`, or `update_time` set. Requests with `show_missing` may not
+        #   specify `where` or `order_by`.
         # @param [String] transaction
-        #   Reads documents in a transaction.
+        #   Perform the read as part of an already active transaction.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -562,7 +576,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Listens to changes.
+        # Listens to changes. This method is only available via the gRPC API (not REST).
         # @param [String] database
         #   Required. The database name. In the format: `projects/`project_id`/databases/`
         #   database_id``.
@@ -795,7 +809,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Streams batches of document updates and deletes, in order.
+        # Streams batches of document updates and deletes, in order. This method is only
+        # available via the gRPC API (not REST).
         # @param [String] database
         #   Required. The database name. In the format: `projects/`project_id`/databases/`
         #   database_id``. This is only required in the first message.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2023-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.11.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.11.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.22.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.24.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Firestore API V1beta1