google-apis-domains_v1beta1 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d1bbac8b03c10d67339f43776b427839f4320d190bbe7179b44df13ac9b215e
-  data.tar.gz: dbe5ccbe568cadc9a7f439149402ea6765f157774fda567f0f93c64276fa0f66
+  metadata.gz: 7d96223bb6a40407b63965043c3c2629ccd9bc2d31e2c83d209fe9b4bb57e31d
+  data.tar.gz: 45915085c1800c76da37c6af467c513a79256258a03b4632e532600e0ea91576
 SHA512:
-  metadata.gz: 213fc827472bba0b56fa0aecf1a7cdecef814affd9234dd0d3f8ee13fbf1da1c686f5d0484b705d932bc32d37c52dd2743bf8eb3a82e3877a42ca290bed8cfbc
-  data.tar.gz: b17e65f1434d301098da01a5820e311142c8f922e15c272270943f783bc9c40b941614fcc9429e7b4bf657245986e9cb3cd827e7d7d22224944aa7536fd05732
+  metadata.gz: f6d0c8c5b051a87f2643ddfe03283b696b2d7029c47a2859a055bf0764a7d2689c0b08d2f1398600f6ad79cd761bf73fd18cb27db6cf10bd226f1a9ef54aad3a
+  data.tar.gz: 6e2da33f7078918ffbcde16a5792185fdad6d2be20b4cafcefb2a93d7643f440e7ec8a12d4ca4d60d89b54cdd0a0327e4e6770b5956691d5fd0e55bc20f15b46

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-domains_v1beta1
 
+### v0.17.0 (2022-06-25)
+
+* Regenerated from discovery document revision 20220616
+
 ### v0.16.0 (2022-06-18)
 
 * Regenerated using generator version 0.7.0

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

@@ -446,6 +446,37 @@ module Google
         end
       end
       
+      # A domain that the calling user manages in Google Domains.
+      class Domain
+        include Google::Apis::Core::Hashable
+      
+        # The domain name. Unicode domain names are expressed in Punycode format.
+        # Corresponds to the JSON property `domainName`
+        # @return [String]
+        attr_accessor :domain_name
+      
+        # The state of this domain as a `Registration` resource.
+        # Corresponds to the JSON property `resourceState`
+        # @return [String]
+        attr_accessor :resource_state
+      
+        # Represents an amount of money with its currency type.
+        # Corresponds to the JSON property `yearlyPrice`
+        # @return [Google::Apis::DomainsV1beta1::Money]
+        attr_accessor :yearly_price
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @domain_name = args[:domain_name] if args.key?(:domain_name)
+          @resource_state = args[:resource_state] if args.key?(:resource_state)
+          @yearly_price = args[:yearly_price] if args.key?(:yearly_price)
+        end
+      end
+      
       # Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for
       # a domain. It contains a digest (hash) of a DNSKEY record that must be present
       # in the domain's DNS zone.
@@ -631,6 +662,32 @@ module Google
         end
       end
       
+      # Request for the `ImportDomain` method.
+      class ImportDomainRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The domain name. Unicode domain names must be expressed in Punycode
+        # format.
+        # Corresponds to the JSON property `domainName`
+        # @return [String]
+        attr_accessor :domain_name
+      
+        # Set of labels associated with the `Registration`.
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @domain_name = args[:domain_name] if args.key?(:domain_name)
+          @labels = args[:labels] if args.key?(:labels)
+        end
+      end
+      
       # The response message for Locations.ListLocations.
       class ListLocationsResponse
         include Google::Apis::Core::Hashable
@@ -1181,7 +1238,11 @@ module Google
         # registrar to unlock the domain for transfer and retrieve the domain's transfer
         # authorization code. Then call `RetrieveTransferParameters` to confirm that the
         # domain is unlocked and to get values needed to build a call to `TransferDomain`
-        # .
+        # . Finally, you can create a new `Registration` by importing an existing domain
+        # managed with [Google Domains](https://domains.google/). First, call `
+        # RetrieveImportableDomains` to list domains to which the calling user has
+        # sufficient access. Then call `ImportDomain` on any domain names you want to
+        # use with Cloud Domains.
         # Corresponds to the JSON property `registration`
         # @return [Google::Apis::DomainsV1beta1::Registration]
         attr_accessor :registration
@@ -1269,7 +1330,11 @@ module Google
       # registrar to unlock the domain for transfer and retrieve the domain's transfer
       # authorization code. Then call `RetrieveTransferParameters` to confirm that the
       # domain is unlocked and to get values needed to build a call to `TransferDomain`
-      # .
+      # . Finally, you can create a new `Registration` by importing an existing domain
+      # managed with [Google Domains](https://domains.google/). First, call `
+      # RetrieveImportableDomains` to list domains to which the calling user has
+      # sufficient access. Then call `ImportDomain` on any domain names you want to
+      # use with Cloud Domains.
       class Registration
         include Google::Apis::Core::Hashable
       
@@ -1332,6 +1397,12 @@ module Google
         # @return [Google::Apis::DomainsV1beta1::ContactSettings]
         attr_accessor :pending_contact_settings
       
+        # Output only. The reason the domain registration failed. Only set for domains
+        # in REGISTRATION_FAILED state.
+        # Corresponds to the JSON property `registerFailureReason`
+        # @return [String]
+        attr_accessor :register_failure_reason
+      
         # Output only. The state of the `Registration`
         # Corresponds to the JSON property `state`
         # @return [String]
@@ -1343,6 +1414,12 @@ module Google
         # @return [Array<String>]
         attr_accessor :supported_privacy
       
+        # Output only. The reason the domain transfer failed. Only set for domains in
+        # TRANSFER_FAILED state.
+        # Corresponds to the JSON property `transferFailureReason`
+        # @return [String]
+        attr_accessor :transfer_failure_reason
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1359,8 +1436,10 @@ module Google
           @management_settings = args[:management_settings] if args.key?(:management_settings)
           @name = args[:name] if args.key?(:name)
           @pending_contact_settings = args[:pending_contact_settings] if args.key?(:pending_contact_settings)
+          @register_failure_reason = args[:register_failure_reason] if args.key?(:register_failure_reason)
           @state = args[:state] if args.key?(:state)
           @supported_privacy = args[:supported_privacy] if args.key?(:supported_privacy)
+          @transfer_failure_reason = args[:transfer_failure_reason] if args.key?(:transfer_failure_reason)
         end
       end
       
@@ -1377,6 +1456,32 @@ module Google
         end
       end
       
+      # Response for the `RetrieveImportableDomains` method.
+      class RetrieveImportableDomainsResponse
+        include Google::Apis::Core::Hashable
+      
+        # A list of domains that the calling user manages in Google Domains.
+        # Corresponds to the JSON property `domains`
+        # @return [Array<Google::Apis::DomainsV1beta1::Domain>]
+        attr_accessor :domains
+      
+        # When present, there are more results to retrieve. Set `page_token` to this
+        # value on a subsequent call to get the next page of results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @domains = args[:domains] if args.key?(:domains)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response for the `RetrieveRegisterParameters` method.
       class RetrieveRegisterParametersResponse
         include Google::Apis::Core::Hashable
@@ -1592,7 +1697,11 @@ module Google
         # registrar to unlock the domain for transfer and retrieve the domain's transfer
         # authorization code. Then call `RetrieveTransferParameters` to confirm that the
         # domain is unlocked and to get values needed to build a call to `TransferDomain`
-        # .
+        # . Finally, you can create a new `Registration` by importing an existing domain
+        # managed with [Google Domains](https://domains.google/). First, call `
+        # RetrieveImportableDomains` to list domains to which the calling user has
+        # sufficient access. Then call `ImportDomain` on any domain names you want to
+        # use with Cloud Domains.
         # Corresponds to the JSON property `registration`
         # @return [Google::Apis::DomainsV1beta1::Registration]
         attr_accessor :registration
@@ -1631,6 +1740,11 @@ module Google
         # @return [String]
         attr_accessor :current_registrar
       
+        # The URL of registrar that currently manages the domain.
+        # Corresponds to the JSON property `currentRegistrarUri`
+        # @return [String]
+        attr_accessor :current_registrar_uri
+      
         # The domain name. Unicode domain names are expressed in Punycode format.
         # Corresponds to the JSON property `domainName`
         # @return [String]
@@ -1665,6 +1779,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @current_registrar = args[:current_registrar] if args.key?(:current_registrar)
+          @current_registrar_uri = args[:current_registrar_uri] if args.key?(:current_registrar_uri)
           @domain_name = args[:domain_name] if args.key?(:domain_name)
           @name_servers = args[:name_servers] if args.key?(:name_servers)
           @supported_privacy = args[:supported_privacy] if args.key?(:supported_privacy)

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DomainsV1beta1
       # Version of the google-apis-domains_v1beta1 gem
-      GEM_VERSION = "0.16.0"
+      GEM_VERSION = "0.17.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.7.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220517"
+      REVISION = "20220616"
     end
   end
 end

data/lib/google/apis/domains_v1beta1/representations.rb

@@ -88,6 +88,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Domain
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class DsRecord
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -118,6 +124,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ImportDomainRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ListLocationsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -202,6 +214,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RetrieveImportableDomainsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class RetrieveRegisterParametersResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -365,6 +383,16 @@ module Google
         end
       end
       
+      class Domain
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :domain_name, as: 'domainName'
+          property :resource_state, as: 'resourceState'
+          property :yearly_price, as: 'yearlyPrice', class: Google::Apis::DomainsV1beta1::Money, decorator: Google::Apis::DomainsV1beta1::Money::Representation
+      
+        end
+      end
+      
       class DsRecord
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -410,6 +438,14 @@ module Google
         end
       end
       
+      class ImportDomainRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :domain_name, as: 'domainName'
+          hash :labels, as: 'labels'
+        end
+      end
+      
       class ListLocationsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -560,8 +596,10 @@ module Google
           property :name, as: 'name'
           property :pending_contact_settings, as: 'pendingContactSettings', class: Google::Apis::DomainsV1beta1::ContactSettings, decorator: Google::Apis::DomainsV1beta1::ContactSettings::Representation
       
+          property :register_failure_reason, as: 'registerFailureReason'
           property :state, as: 'state'
           collection :supported_privacy, as: 'supportedPrivacy'
+          property :transfer_failure_reason, as: 'transferFailureReason'
         end
       end
       
@@ -571,6 +609,15 @@ module Google
         end
       end
       
+      class RetrieveImportableDomainsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :domains, as: 'domains', class: Google::Apis::DomainsV1beta1::Domain, decorator: Google::Apis::DomainsV1beta1::Domain::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class RetrieveRegisterParametersResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -645,6 +692,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :current_registrar, as: 'currentRegistrar'
+          property :current_registrar_uri, as: 'currentRegistrarUri'
           property :domain_name, as: 'domainName'
           collection :name_servers, as: 'nameServers'
           collection :supported_privacy, as: 'supportedPrivacy'

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

@@ -458,6 +458,43 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Imports a domain name from [Google Domains](https://domains.google/) for use
+        # in Cloud Domains. To transfer a domain from another registrar, use the `
+        # TransferDomain` method instead. Since individual users can own domains in
+        # Google Domains, the calling user must have ownership permission on the domain.
+        # @param [String] parent
+        #   Required. The parent resource of the Registration. Must be in the format `
+        #   projects/*/locations/*`.
+        # @param [Google::Apis::DomainsV1beta1::ImportDomainRequest] import_domain_request_object
+        # @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::DomainsV1beta1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DomainsV1beta1::Operation]
+        #
+        # @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 import_registration_domain(parent, import_domain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta1/{+parent}/registrations:import', options)
+          command.request_representation = Google::Apis::DomainsV1beta1::ImportDomainRequest::Representation
+          command.request_object = import_domain_request_object
+          command.response_representation = Google::Apis::DomainsV1beta1::Operation::Representation
+          command.response_class = Google::Apis::DomainsV1beta1::Operation
+          command.params['parent'] = parent unless parent.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 `Registration` resources in a project.
         # @param [String] parent
         #   Required. The project and location from which to list `Registration`s,
@@ -663,6 +700,47 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Lists domain names from [Google Domains](https://domains.google/) that can be
+        # imported to Cloud Domains using the `ImportDomain` method. Since individual
+        # users can own domains in Google Domains, the list of domains returned depends
+        # on the individual user making the call. Domains supported by Google Domains,
+        # but not supported by Cloud Domains, are not returned.
+        # @param [String] location
+        #   Required. The location. Must be in the format `projects/*/locations/*`.
+        # @param [Fixnum] page_size
+        #   Maximum number of results to return.
+        # @param [String] page_token
+        #   When set to the `next_page_token` from a prior response, provides the next
+        #   page of results.
+        # @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::DomainsV1beta1::RetrieveImportableDomainsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DomainsV1beta1::RetrieveImportableDomainsResponse]
+        #
+        # @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 retrieve_project_location_registration_importable_domains(location, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+location}/registrations:retrieveImportableDomains', options)
+          command.response_representation = Google::Apis::DomainsV1beta1::RetrieveImportableDomainsResponse::Representation
+          command.response_class = Google::Apis::DomainsV1beta1::RetrieveImportableDomainsResponse
+          command.params['location'] = location unless location.nil?
+          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
+        
         # Gets parameters needed to register a new domain name, including price and up-
         # to-date availability. Use the returned values to call `RegisterDomain`.
         # @param [String] location
@@ -699,8 +777,9 @@ module Google
         end
         
         # Gets parameters needed to transfer a domain name from another registrar to
-        # Cloud Domains. For domains managed by Google Domains, transferring to Cloud
-        # Domains is not supported. Use the returned values to call `TransferDomain`.
+        # Cloud Domains. For domains already managed by [Google Domains](https://domains.
+        # google/), use `ImportDomain` instead. Use the returned values to call `
+        # TransferDomain`.
         # @param [String] location
         #   Required. The location. Must be in the format `projects/*/locations/*`.
         # @param [String] domain_name
@@ -847,20 +926,20 @@ module Google
         end
         
         # Transfers a domain name from another registrar to Cloud Domains. For domains
-        # managed by Google Domains, transferring to Cloud Domains is not supported.
-        # Before calling this method, go to the domain's current registrar to unlock the
-        # domain for transfer and retrieve the domain's transfer authorization code.
-        # Then call `RetrieveTransferParameters` to confirm that the domain is unlocked
-        # and to get values needed to build a call to this method. A successful call
-        # creates a `Registration` resource in state `TRANSFER_PENDING`. It can take
-        # several days to complete the transfer process. The registrant can often speed
-        # up this process by approving the transfer through the current registrar,
-        # either by clicking a link in an email from the registrar or by visiting the
-        # registrar's website. A few minutes after transfer approval, the resource
-        # transitions to state `ACTIVE`, indicating that the transfer was successful. If
-        # the transfer is rejected or the request expires without being approved, the
-        # resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can
-        # safely delete the resource and retry the transfer.
+        # already managed by [Google Domains](https://domains.google/), use `
+        # ImportDomain` instead. Before calling this method, go to the domain's current
+        # registrar to unlock the domain for transfer and retrieve the domain's transfer
+        # authorization code. Then call `RetrieveTransferParameters` to confirm that the
+        # domain is unlocked and to get values needed to build a call to this method. A
+        # successful call creates a `Registration` resource in state `TRANSFER_PENDING`.
+        # It can take several days to complete the transfer process. The registrant can
+        # often speed up this process by approving the transfer through the current
+        # registrar, either by clicking a link in an email from the registrar or by
+        # visiting the registrar's website. A few minutes after transfer approval, the
+        # resource transitions to state `ACTIVE`, indicating that the transfer was
+        # successful. If the transfer is rejected or the request expires without being
+        # approved, the resource can end up in state `TRANSFER_FAILED`. If transfer
+        # fails, you can safely delete the resource and retry the transfer.
         # @param [String] parent
         #   Required. The parent resource of the `Registration`. Must be in the format `
         #   projects/*/locations/*`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-domains_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-20 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -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-domains_v1beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-domains_v1beta1/v0.16.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-domains_v1beta1/v0.17.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-domains_v1beta1
 post_install_message: 
 rdoc_options: []