google-api-client 0.41.1 → 0.43.0

data/generated/google/apis/gmailpostmastertools_v1beta1/service.rb

@@ -0,0 +1,230 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module GmailpostmastertoolsV1beta1
+      # Gmail Postmaster Tools API
+      #
+      # The Gmail Postmaster API is a RESTful API that provides programmatic access to
+      #  email traffic metrics (like spam reports, delivery errors etc) otherwise
+      #  available through the Gmail Postmaster Tools UI currently.
+      #
+      # @example
+      #    require 'google/apis/gmailpostmastertools_v1beta1'
+      #
+      #    Gmailpostmastertools = Google::Apis::GmailpostmastertoolsV1beta1 # Alias the module
+      #    service = Gmailpostmastertools::PostmasterToolsService.new
+      #
+      # @see https://developers.google.com/gmail/postmaster
+      class PostmasterToolsService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  Available to use for quota purposes for server-side applications. Can be any
+        #  arbitrary string assigned to a user, but should not exceed 40 characters.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://gmailpostmastertools.googleapis.com/', '')
+          @batch_path = 'batch'
+        end
+        
+        # Gets a specific domain registered by the client. Returns NOT_FOUND if the
+        # domain does not exist.
+        # @param [String] name
+        #   The resource name of the domain. It should have the form `domains/`domain_name`
+        #   `, where domain_name is the fully qualified domain name.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::Domain] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::GmailpostmastertoolsV1beta1::Domain]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_domain(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+name}', options)
+          command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::Domain::Representation
+          command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::Domain
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists the domains that have been registered by the client. The order of
+        # domains in the response is unspecified and non-deterministic. Newly created
+        # domains will not necessarily be added to the end of this list.
+        # @param [Fixnum] page_size
+        #   Requested page size. Server may return fewer domains than requested. If
+        #   unspecified, server will pick an appropriate default.
+        # @param [String] page_token
+        #   The next_page_token value returned from a previous List request, if any. This
+        #   is the value of ListDomainsResponse.next_page_token returned from the previous
+        #   call to `ListDomains` method.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_domains(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/domains', options)
+          command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse::Representation
+          command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Get traffic statistics for a domain on a specific date. Returns
+        # PERMISSION_DENIED if user does not have permission to access TrafficStats for
+        # the domain.
+        # @param [String] name
+        #   The resource name of the traffic statistics to get. E.g., domains/mymail.
+        #   mydomain.com/trafficStats/20160807.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_domain_traffic_stat(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+name}', options)
+          command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats::Representation
+          command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # List traffic statistics for all available days. Returns PERMISSION_DENIED if
+        # user does not have permission to access TrafficStats for the domain.
+        # @param [String] parent
+        #   The resource name of the domain whose traffic statistics we'd like to list. It
+        #   should have the form `domains/`domain_name``, where domain_name is the fully
+        #   qualified domain name.
+        # @param [Fixnum] end_date_day
+        #   Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if
+        #   specifying a year by itself or a year and month where the day is not
+        #   significant.
+        # @param [Fixnum] end_date_month
+        #   Month of year. Must be from 1 to 12, or 0 if specifying a year without a month
+        #   and day.
+        # @param [Fixnum] end_date_year
+        #   Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+        # @param [Fixnum] page_size
+        #   Requested page size. Server may return fewer TrafficStats than requested. If
+        #   unspecified, server will pick an appropriate default.
+        # @param [String] page_token
+        #   The next_page_token value returned from a previous List request, if any. This
+        #   is the value of ListTrafficStatsResponse.next_page_token returned from the
+        #   previous call to `ListTrafficStats` method.
+        # @param [Fixnum] start_date_day
+        #   Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if
+        #   specifying a year by itself or a year and month where the day is not
+        #   significant.
+        # @param [Fixnum] start_date_month
+        #   Month of year. Must be from 1 to 12, or 0 if specifying a year without a month
+        #   and day.
+        # @param [Fixnum] start_date_year
+        #   Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_domain_traffic_stats(parent, end_date_day: nil, end_date_month: nil, end_date_year: nil, page_size: nil, page_token: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+parent}/trafficStats', options)
+          command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse::Representation
+          command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['endDate.day'] = end_date_day unless end_date_day.nil?
+          command.query['endDate.month'] = end_date_month unless end_date_month.nil?
+          command.query['endDate.year'] = end_date_year unless end_date_year.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['startDate.day'] = start_date_day unless start_date_day.nil?
+          command.query['startDate.month'] = start_date_month unless start_date_month.nil?
+          command.query['startDate.year'] = start_date_year unless start_date_year.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/groupssettings_v1.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://developers.google.com/google-apps/groups-settings/get_started
     module GroupssettingsV1
       VERSION = 'V1'
-      REVISION = '20190725'
+      REVISION = '20200617'
 
       # View and manage the settings of a G Suite group
       AUTH_APPS_GROUPS_SETTINGS = 'https://www.googleapis.com/auth/apps.groups.settings'

data/generated/google/apis/groupssettings_v1/classes.rb

@@ -213,7 +213,7 @@ module Google
         # @return [String]
         attr_accessor :primary_language
       
-        # Specifies who should the default reply go to. Possible values are:
+        # Specifies who receives the default reply. Possible values are:
         # - REPLY_TO_CUSTOM: For replies to messages, use the group's custom email
         # address.
         # When the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo

data/generated/google/apis/healthcare_v1.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://cloud.google.com/healthcare
     module HealthcareV1
       VERSION = 'V1'
-      REVISION = '20200612'
+      REVISION = '20200723'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

data/generated/google/apis/healthcare_v1/service.rb

@@ -990,6 +990,9 @@ module Google
         # are equivalent to the GET requests specified in the Retrieve transaction.
         # The method returns an Operation which
         # will be marked successful when the deletion is complete.
+        # Warning: Inserting instances into a study while a delete operation is
+        # running for that study could result in the new instances not appearing in
+        # search results until the deletion operation finishes.
         # @param [String] parent
         # @param [String] dicom_web_path
         #   The path of the DeleteStudy request. For example, `studies/`study_uid``.
@@ -1227,6 +1230,9 @@ module Google
         # Retrieve transaction.
         # The method returns an Operation which
         # will be marked successful when the deletion is complete.
+        # Warning: Inserting instances into a series while a delete operation is
+        # running for that series could result in the new instances not appearing in
+        # search results until the deletion operation finishes.
         # @param [String] parent
         #   The name of the DICOM store that is being accessed. For example,
         #   `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -2136,17 +2142,29 @@ module Google
         # [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html),
         # [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which
         # details the eligible resource types and referencing search parameters.
+        # For samples that show how to call `Patient-everything`, see
+        # [Getting all patient compartment
+        # resources](/healthcare/docs/how-tos/fhir-resources#
+        # getting_all_patient_compartment_resources).
         # @param [String] name
         #   Name of the `Patient` resource for which the information is required.
         # @param [Fixnum] _count
         #   Maximum number of resources in a page. Defaults to 100.
         # @param [String] _page_token
         #   Used to retrieve the next or previous page of results
-        #   when using pagination. Value should be set to the value of page_token set
-        #   in next or previous page links' urls. Next and previous page are returned
+        #   when using pagination. Set `_page_token` to the value of _page_token set
+        #   in next or previous page links' url. Next and previous page are returned
         #   in the response bundle's links field, where `link.relation` is "previous"
         #   or "next".
-        #   Omit `page_token` if no previous request has been made.
+        #   Omit `_page_token` if no previous request has been made.
+        # @param [String] _since
+        #   If provided, only resources updated after this time are
+        #   returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz.
+        #   For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`.
+        #   The time must be specified to the second and include a time zone.
+        # @param [String] _type
+        #   String of comma-delimited FHIR resource types. If provided, only resources
+        #   of the specified resource type(s) are returned.
         # @param [String] end_
         #   The response includes records prior to the end date. If no end date is
         #   provided, all records subsequent to the start date are in scope.
@@ -2170,13 +2188,15 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def patient_project_location_dataset_fhir_store_fhir_everything(name, _count: nil, _page_token: nil, end_: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
+        def patient_project_location_dataset_fhir_store_fhir_everything(name, _count: nil, _page_token: nil, _since: nil, _type: nil, end_: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1/{+name}/$everything', options)
           command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
           command.response_class = Google::Apis::HealthcareV1::HttpBody
           command.params['name'] = name unless name.nil?
           command.query['_count'] = _count unless _count.nil?
           command.query['_page_token'] = _page_token unless _page_token.nil?
+          command.query['_since'] = _since unless _since.nil?
+          command.query['_type'] = _type unless _type.nil?
           command.query['end'] = end_ unless end_.nil?
           command.query['start'] = start unless start.nil?
           command.query['fields'] = fields unless fields.nil?
@@ -2188,6 +2208,10 @@ module Google
         # version) from the FHIR store. To remove all versions of a resource, first
         # delete the current version and then call this method.
         # This is not a FHIR standard operation.
+        # For samples that show how to call `Resource-purge`, see
+        # [Deleting historical versions of a FHIR
+        # resource](/healthcare/docs/how-tos/fhir-resources#
+        # deleting_historical_versions_of_a_fhir_resource).
         # @param [String] name
         #   The name of the resource to purge.
         # @param [String] fields
@@ -2277,6 +2301,9 @@ module Google
         # `OperationOutcome` resource describing the reason for the error. If the
         # request cannot be mapped to a valid API method on a FHIR store, a generic
         # GCP error might be returned instead.
+        # For samples that show how to call `create`, see
+        # [Creating a FHIR
+        # resource](/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).
         # @param [String] parent
         #   The name of the FHIR store this resource belongs to.
         # @param [String] type
@@ -2328,6 +2355,9 @@ module Google
         # repository that can still be retrieved through vread
         # and related methods, unless they are removed by the
         # purge method.
+        # For samples that show how to call `delete`, see
+        # [Deleting a FHIR
+        # resource](/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).
         # @param [String] name
         #   The name of the resource to delete.
         # @param [String] fields
@@ -2382,6 +2412,9 @@ module Google
         # a JSON-encoded `OperationOutcome` resource describing the reason for the
         # error. If the request cannot be mapped to a valid API method on a FHIR
         # store, a generic GCP error might be returned instead.
+        # For samples that show how to call `executeBundle`, see
+        # [Managing FHIR resources using FHIR
+        # bundles](/healthcare/docs/how-tos/fhir-bundles).
         # @param [String] parent
         #   Name of the FHIR store in which this bundle will be executed.
         # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
@@ -2427,6 +2460,10 @@ module Google
         # `OperationOutcome` resource describing the reason for the error. If the
         # request cannot be mapped to a valid API method on a FHIR store, a generic
         # GCP error might be returned instead.
+        # For samples that show how to call `history`, see
+        # [Listing FHIR resource
+        # versions](/healthcare/docs/how-tos/fhir-resources#
+        # listing_fhir_resource_versions).
         # @param [String] name
         #   The name of the resource to retrieve.
         # @param [String] _at
@@ -2499,6 +2536,9 @@ module Google
         # `OperationOutcome` resource describing the reason for the error. If the
         # request cannot be mapped to a valid API method on a FHIR store, a generic
         # GCP error might be returned instead.
+        # For samples that show how to call `patch`, see
+        # [Patching a FHIR
+        # resource](/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).
         # @param [String] name
         #   The name of the resource to update.
         # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
@@ -2548,6 +2588,9 @@ module Google
         # `OperationOutcome` resource describing the reason for the error. If the
         # request cannot be mapped to a valid API method on a FHIR store, a generic
         # GCP error might be returned instead.
+        # For samples that show how to call `read`, see
+        # [Getting a FHIR
+        # resource](/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).
         # @param [String] name
         #   The name of the resource to retrieve.
         # @param [String] fields
@@ -2627,6 +2670,9 @@ module Google
         # Note: FHIR resources are indexed asynchronously, so there might be a slight
         # delay between the time a resource is created or changes and when the change
         # is reflected in search results.
+        # For samples and detailed information, see [Searching for FHIR
+        # resources](/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search
+        # features](/healthcare/docs/how-tos/fhir-advanced-search).
         # @param [String] parent
         #   Name of the FHIR store to retrieve resources from.
         # @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
@@ -2678,6 +2724,9 @@ module Google
         # `OperationOutcome` resource describing the reason for the error. If the
         # request cannot be mapped to a valid API method on a FHIR store, a generic
         # GCP error might be returned instead.
+        # For samples that show how to call `update`, see
+        # [Updating a FHIR
+        # resource](/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).
         # @param [String] name
         #   The name of the resource to update.
         # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
@@ -2722,6 +2771,10 @@ module Google
         # `OperationOutcome` resource describing the reason for the error. If the
         # request cannot be mapped to a valid API method on a FHIR store, a generic
         # GCP error might be returned instead.
+        # For samples that show how to call `vread`, see
+        # [Retrieving a FHIR resource
+        # version](/healthcare/docs/how-tos/fhir-resources#
+        # retrieving_a_fhir_resource_version).
         # @param [String] name
         #   The name of the resource version to retrieve.
         # @param [String] fields
@@ -3050,12 +3103,12 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Creates a message and sends a notification to the Cloud Pub/Sub topic. If
-        # configured, the MLLP adapter listens to messages created by this method and
-        # sends those back to the hospital. A successful response indicates the
-        # message has been persisted to storage and a Cloud Pub/Sub notification has
-        # been sent. Sending to the hospital by the MLLP adapter happens
-        # asynchronously.
+        # Parses and stores an HL7v2 message. This method triggers an asynchronous
+        # notification to any Cloud Pub/Sub topic configured in
+        # projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the
+        # filtering matches the message. If an MLLP adapter is configured to listen
+        # to a Cloud Pub/Sub topic, the adapter transmits the message when a
+        # notification is received.
         # @param [String] parent
         #   The name of the dataset this message belongs to.
         # @param [Google::Apis::HealthcareV1::CreateMessageRequest] create_message_request_object
@@ -3152,9 +3205,15 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Ingests a new HL7v2 message from the hospital and sends a notification to
-        # the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was
-        # successfully stored. Otherwise an error is returned.
+        # Parses and stores an HL7v2 message. This method triggers an asynchronous
+        # notification to any Cloud Pub/Sub topic configured in
+        # projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the
+        # filtering matches the message. If an MLLP adapter is configured to listen
+        # to a Cloud Pub/Sub topic, the adapter transmits the message when a
+        # notification is received. This method also generates a response
+        # containing an HL7v2 acknowledgement (`ACK`) message when successful or a
+        # negative acknowledgement (`NACK`) message in case of error, suitable for
+        # replying to HL7v2 interface systems that expect these acknowledgements.
         # @param [String] parent
         #   The name of the HL7v2 store this message belongs to.
         # @param [Google::Apis::HealthcareV1::IngestMessageRequest] ingest_message_request_object