google-apis-domains_v1alpha2 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bebc08d0218031781781c30225502daca1e068578d18605e230568da28b0c45
-  data.tar.gz: a786ba61d5e58b3392b35f86d92ab9034f912dc14b70a6c6396f24e8d10eac20
+  metadata.gz: 4580be4ffa55a6d7d08534d64dffde10b6fdc0b25967a7776c043bc6ec427227
+  data.tar.gz: 45d16ca47ba1a3161a957dc7c3c8fdcd7ace2b5449d4bcbcf1660c15d3123fd4
 SHA512:
-  metadata.gz: e88325bff032fb91e4c4304aef233adf067c086e3bd4ae3b9e7b4a06500257a35ae7a5ebb00bcbfff34e674b006a964ad7af53fc164daa15a35b75073dde8b0f
-  data.tar.gz: c79e7d62d39d644cafe5213c842804e03aa6db96621c2b348cea5c3fc722f67c9777a9aefee28c0dad972b189c8b153804cbac37cb990cf1b07231f9178c4727
+  metadata.gz: e714e9627392bb26aedc4118092826dc4f7e9c74ee9ba6c139828200a5dffef68619c6189718adb0372ed37ba038402ed1e7dc43b4ee5b8a2bbc09f47495a82d
+  data.tar.gz: a4d3403f802eef00338a6ae0ba1f60d5b6288da4b69e58ca72384f6cc5f5552ca51cfcec8e1bd6a2002ebe5ed4e9a9563c16518ebb12efe6cda768a5073e4790

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-domains_v1alpha2
 
+### v0.9.0 (2021-10-09)
+
+* Regenerated from discovery document revision 20211004
+
 ### v0.8.0 (2021-10-03)
 
 * Regenerated from discovery document revision 20210927

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

@@ -963,7 +963,12 @@ module Google
       
         # Associates a list of `members` to a `role`. Optionally, may specify a `
         # condition` that determines how and when the `bindings` are applied. Each of
-        # the `bindings` must contain at least one member.
+        # the `bindings` must contain at least one member. The `bindings` in a `Policy`
+        # can refer to up to 1,500 members; up to 250 of these members can be Google
+        # groups. Each occurrence of a member counts towards these limits. For example,
+        # if the `bindings` grant 50 different roles to `user:alice@example.com`, and
+        # not to any other member, then you can add another 1,450 members to the `
+        # bindings` in the `Policy`.
         # Corresponds to the JSON property `bindings`
         # @return [Array<Google::Apis::DomainsV1alpha2::Binding>]
         attr_accessor :bindings
@@ -1166,11 +1171,17 @@ module Google
         attr_accessor :domain_notices
       
         # The `Registration` resource facilitates managing and configuring domain name
-        # registrations. To create a new `Registration` resource, find a suitable domain
-        # name by calling the `SearchDomains` method with a query to see available
-        # domain name options. After choosing a name, call `RetrieveRegisterParameters`
-        # to ensure availability and obtain information like pricing, which is needed to
-        # build a call to `RegisterDomain`.
+        # registrations. There are several ways to create a new `Registration` resource:
+        # To create a new `Registration` resource, find a suitable domain name by
+        # calling the `SearchDomains` method with a query to see available domain name
+        # options. After choosing a name, call `RetrieveRegisterParameters` to ensure
+        # availability and obtain information like pricing, which is needed to build a
+        # call to `RegisterDomain`. Another way to create a new `Registration` is to
+        # transfer an existing domain from another registrar. First, go to the 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 `TransferDomain`
+        # .
         # Corresponds to the JSON property `registration`
         # @return [Google::Apis::DomainsV1alpha2::Registration]
         attr_accessor :registration
@@ -1248,11 +1259,17 @@ module Google
       end
       
       # The `Registration` resource facilitates managing and configuring domain name
-      # registrations. To create a new `Registration` resource, find a suitable domain
-      # name by calling the `SearchDomains` method with a query to see available
-      # domain name options. After choosing a name, call `RetrieveRegisterParameters`
-      # to ensure availability and obtain information like pricing, which is needed to
-      # build a call to `RegisterDomain`.
+      # registrations. There are several ways to create a new `Registration` resource:
+      # To create a new `Registration` resource, find a suitable domain name by
+      # calling the `SearchDomains` method with a query to see available domain name
+      # options. After choosing a name, call `RetrieveRegisterParameters` to ensure
+      # availability and obtain information like pricing, which is needed to build a
+      # call to `RegisterDomain`. Another way to create a new `Registration` is to
+      # transfer an existing domain from another registrar. First, go to the 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 `TransferDomain`
+      # .
       class Registration
         include Google::Apis::Core::Hashable
       
@@ -1379,6 +1396,25 @@ module Google
         end
       end
       
+      # Response for the `RetrieveTransferParameters` method.
+      class RetrieveTransferParametersResponse
+        include Google::Apis::Core::Hashable
+      
+        # Parameters required to transfer a domain from another registrar.
+        # Corresponds to the JSON property `transferParameters`
+        # @return [Google::Apis::DomainsV1alpha2::TransferParameters]
+        attr_accessor :transfer_parameters
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @transfer_parameters = args[:transfer_parameters] if args.key?(:transfer_parameters)
+        end
+      end
+      
       # Response for the `SearchDomains` method.
       class SearchDomainsResponse
         include Google::Apis::Core::Hashable
@@ -1529,6 +1565,113 @@ module Google
           @permissions = args[:permissions] if args.key?(:permissions)
         end
       end
+      
+      # Request for the `TransferDomain` method.
+      class TransferDomainRequest
+        include Google::Apis::Core::Hashable
+      
+        # Defines an authorization code.
+        # Corresponds to the JSON property `authorizationCode`
+        # @return [Google::Apis::DomainsV1alpha2::AuthorizationCode]
+        attr_accessor :authorization_code
+      
+        # The list of contact notices that you acknowledge. The notices needed here
+        # depend on the values specified in `registration.contact_settings`.
+        # Corresponds to the JSON property `contactNotices`
+        # @return [Array<String>]
+        attr_accessor :contact_notices
+      
+        # The `Registration` resource facilitates managing and configuring domain name
+        # registrations. There are several ways to create a new `Registration` resource:
+        # To create a new `Registration` resource, find a suitable domain name by
+        # calling the `SearchDomains` method with a query to see available domain name
+        # options. After choosing a name, call `RetrieveRegisterParameters` to ensure
+        # availability and obtain information like pricing, which is needed to build a
+        # call to `RegisterDomain`. Another way to create a new `Registration` is to
+        # transfer an existing domain from another registrar. First, go to the 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 `TransferDomain`
+        # .
+        # Corresponds to the JSON property `registration`
+        # @return [Google::Apis::DomainsV1alpha2::Registration]
+        attr_accessor :registration
+      
+        # Validate the request without actually transferring the domain.
+        # Corresponds to the JSON property `validateOnly`
+        # @return [Boolean]
+        attr_accessor :validate_only
+        alias_method :validate_only?, :validate_only
+      
+        # Represents an amount of money with its currency type.
+        # Corresponds to the JSON property `yearlyPrice`
+        # @return [Google::Apis::DomainsV1alpha2::Money]
+        attr_accessor :yearly_price
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @authorization_code = args[:authorization_code] if args.key?(:authorization_code)
+          @contact_notices = args[:contact_notices] if args.key?(:contact_notices)
+          @registration = args[:registration] if args.key?(:registration)
+          @validate_only = args[:validate_only] if args.key?(:validate_only)
+          @yearly_price = args[:yearly_price] if args.key?(:yearly_price)
+        end
+      end
+      
+      # Parameters required to transfer a domain from another registrar.
+      class TransferParameters
+        include Google::Apis::Core::Hashable
+      
+        # The registrar that currently manages the domain.
+        # Corresponds to the JSON property `currentRegistrar`
+        # @return [String]
+        attr_accessor :current_registrar
+      
+        # The domain name. Unicode domain names are expressed in Punycode format.
+        # Corresponds to the JSON property `domainName`
+        # @return [String]
+        attr_accessor :domain_name
+      
+        # The name servers that currently store the configuration of the domain.
+        # Corresponds to the JSON property `nameServers`
+        # @return [Array<String>]
+        attr_accessor :name_servers
+      
+        # Contact privacy options that the domain supports.
+        # Corresponds to the JSON property `supportedPrivacy`
+        # @return [Array<String>]
+        attr_accessor :supported_privacy
+      
+        # Indicates whether the domain is protected by a transfer lock. For a transfer
+        # to succeed, this must show `UNLOCKED`. To unlock a domain, go to its current
+        # registrar.
+        # Corresponds to the JSON property `transferLockState`
+        # @return [String]
+        attr_accessor :transfer_lock_state
+      
+        # Represents an amount of money with its currency type.
+        # Corresponds to the JSON property `yearlyPrice`
+        # @return [Google::Apis::DomainsV1alpha2::Money]
+        attr_accessor :yearly_price
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @current_registrar = args[:current_registrar] if args.key?(:current_registrar)
+          @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)
+          @transfer_lock_state = args[:transfer_lock_state] if args.key?(:transfer_lock_state)
+          @yearly_price = args[:yearly_price] if args.key?(:yearly_price)
+        end
+      end
     end
   end
 end

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DomainsV1alpha2
       # Version of the google-apis-domains_v1alpha2 gem
-      GEM_VERSION = "0.8.0"
+      GEM_VERSION = "0.9.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210927"
+      REVISION = "20211004"
     end
   end
 end

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

@@ -208,6 +208,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RetrieveTransferParametersResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class SearchDomainsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -238,6 +244,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class TransferDomainRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class TransferParameters
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class AuditConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -561,6 +579,14 @@ module Google
         end
       end
       
+      class RetrieveTransferParametersResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :transfer_parameters, as: 'transferParameters', class: Google::Apis::DomainsV1alpha2::TransferParameters, decorator: Google::Apis::DomainsV1alpha2::TransferParameters::Representation
+      
+        end
+      end
+      
       class SearchDomainsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -600,6 +626,33 @@ module Google
           collection :permissions, as: 'permissions'
         end
       end
+      
+      class TransferDomainRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :authorization_code, as: 'authorizationCode', class: Google::Apis::DomainsV1alpha2::AuthorizationCode, decorator: Google::Apis::DomainsV1alpha2::AuthorizationCode::Representation
+      
+          collection :contact_notices, as: 'contactNotices'
+          property :registration, as: 'registration', class: Google::Apis::DomainsV1alpha2::Registration, decorator: Google::Apis::DomainsV1alpha2::Registration::Representation
+      
+          property :validate_only, as: 'validateOnly'
+          property :yearly_price, as: 'yearlyPrice', class: Google::Apis::DomainsV1alpha2::Money, decorator: Google::Apis::DomainsV1alpha2::Money::Representation
+      
+        end
+      end
+      
+      class TransferParameters
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :current_registrar, as: 'currentRegistrar'
+          property :domain_name, as: 'domainName'
+          collection :name_servers, as: 'nameServers'
+          collection :supported_privacy, as: 'supportedPrivacy'
+          property :transfer_lock_state, as: 'transferLockState'
+          property :yearly_price, as: 'yearlyPrice', class: Google::Apis::DomainsV1alpha2::Money, decorator: Google::Apis::DomainsV1alpha2::Money::Representation
+      
+        end
+      end
     end
   end
 end

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

@@ -302,14 +302,16 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes a `Registration` resource. For `Registration` resources , this method
-        # works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `
-        # REGISTRATION_FAILED` When an active domain is successfully deleted, you can
-        # continue to use the domain in [Google Domains](https://domains.google/) until
-        # it expires. The calling user becomes the domain's sole owner in Google Domains,
-        # and permissions for the domain are subsequently managed there. The domain
-        # will not renew automatically unless the new owner sets up billing in Google
-        # Domains.
+        # Deletes a `Registration` resource. For `Registration` resources using usage
+        # billing, this method works if: * `state` is `EXPORTED` with `expire_time` in
+        # the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED`
+        # This method works on any `Registration` resource using subscription billing,
+        # provided that the resource was created at least 1 day in the past. When an
+        # active domain is successfully deleted, you can continue to use the domain in [
+        # Google Domains](https://domains.google/) until it expires. The calling user
+        # becomes the domain's sole owner in Google Domains, and permissions for the
+        # domain are subsequently managed there. The domain will not renew automatically
+        # unless the new owner sets up billing in Google Domains.
         # @param [String] name
         #   Required. The name of the `Registration` to delete, in the format `projects/*/
         #   locations/*/registrations/*`.
@@ -691,6 +693,42 @@ module Google
           execute_or_queue_command(command, &block)
         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 yet supported. Use the returned values to call `TransferDomain`.
+        # @param [String] location
+        #   Required. The location. Must be in the format `projects/*/locations/*`.
+        # @param [String] domain_name
+        #   Required. The domain name. Unicode domain names must be expressed in Punycode
+        #   format.
+        # @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::DomainsV1alpha2::RetrieveTransferParametersResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DomainsV1alpha2::RetrieveTransferParametersResponse]
+        #
+        # @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_transfer_parameters(location, domain_name: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha2/{+location}/registrations:retrieveTransferParameters', options)
+          command.response_representation = Google::Apis::DomainsV1alpha2::RetrieveTransferParametersResponse::Representation
+          command.response_class = Google::Apis::DomainsV1alpha2::RetrieveTransferParametersResponse
+          command.params['location'] = location unless location.nil?
+          command.query['domainName'] = domain_name unless domain_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
+        
         # Searches for available domain names similar to the provided query.
         # Availability results from this method are approximate; call `
         # RetrieveRegisterParameters` on a domain before registering to confirm
@@ -800,6 +838,54 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # Transfers a domain name from another registrar to Cloud Domains. For domains
+        # managed by Google Domains, transferring to Cloud Domains is not yet 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.
+        # @param [String] parent
+        #   Required. The parent resource of the `Registration`. Must be in the format `
+        #   projects/*/locations/*`.
+        # @param [Google::Apis::DomainsV1alpha2::TransferDomainRequest] transfer_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::DomainsV1alpha2::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DomainsV1alpha2::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 transfer_registration_domain(parent, transfer_domain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha2/{+parent}/registrations:transfer', options)
+          command.request_representation = Google::Apis::DomainsV1alpha2::TransferDomainRequest::Representation
+          command.request_object = transfer_domain_request_object
+          command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
+          command.response_class = Google::Apis::DomainsV1alpha2::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
 
         protected
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-domains_v1alpha2
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-10-11 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/master/generated/google-apis-domains_v1alpha2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-domains_v1alpha2/v0.8.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-domains_v1alpha2/v0.9.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-domains_v1alpha2
 post_install_message: 
 rdoc_options: []