feat(domains): update the API

#### domains:v1alpha2 The following keys were added: - resources.projects.resources.locations.resources.registrations.methods.export.deprecated - resources.projects.resources.locations.resources.registrations.methods.import.deprecated - resources.projects.resources.locations.resources.registrations.methods.retrieveImportableDomains.deprecated - resources.projects.resources.locations.resources.registrations.methods.retrieveTransferParameters.deprecated - resources.projects.resources.locations.resources.registrations.methods.transfer.deprecated - schemas.ContactSettings.properties.privacy.enumDeprecated - schemas.DnsSettings.properties.googleDomainsDns.deprecated - schemas.ExportRegistrationRequest.deprecated - schemas.GoogleDomainsDns.deprecated - schemas.ImportDomainRequest.deprecated - schemas.ManagementSettings.properties.preferredRenewalMethod.description - schemas.ManagementSettings.properties.preferredRenewalMethod.enum - schemas.ManagementSettings.properties.preferredRenewalMethod.enumDeprecated - schemas.ManagementSettings.properties.preferredRenewalMethod.enumDescriptions - schemas.ManagementSettings.properties.preferredRenewalMethod.type - schemas.ManagementSettings.properties.renewalMethod.enumDeprecated - schemas.RegisterParameters.properties.supportedPrivacy.items.enumDeprecated - schemas.Registration.properties.state.enumDeprecated - schemas.Registration.properties.supportedPrivacy.items.enumDeprecated - schemas.Registration.properties.transferFailureReason.deprecated - schemas.RetrieveImportableDomainsResponse.deprecated - schemas.RetrieveTransferParametersResponse.deprecated - schemas.TransferDomainRequest.deprecated - schemas.TransferParameters.deprecated - schemas.TransferParameters.properties.supportedPrivacy.items.enumDeprecated The following keys were changed: - resources.projects.resources.locations.resources.registrations.methods.delete.description - resources.projects.resources.locations.resources.registrations.methods.export.description - resources.projects.resources.locations.resources.registrations.methods.import.description - resources.projects.resources.locations.resources.registrations.methods.retrieveImportableDomains.description - resources.projects.resources.locations.resources.registrations.methods.retrieveTransferParameters.description - resources.projects.resources.locations.resources.registrations.methods.transfer.description - schemas.ContactSettings.properties.privacy.enumDescriptions - schemas.DnsSettings.properties.googleDomainsDns.description - schemas.ExportRegistrationRequest.description - schemas.GoogleDomainsDns.description - schemas.ImportDomainRequest.description - schemas.ManagementSettings.properties.renewalMethod.description - schemas.ManagementSettings.properties.renewalMethod.enum - schemas.ManagementSettings.properties.renewalMethod.enumDescriptions - schemas.RegisterParameters.properties.supportedPrivacy.items.enumDescriptions - schemas.Registration.description - schemas.Registration.properties.issues.items.enum - schemas.Registration.properties.issues.items.enumDescriptions - schemas.Registration.properties.state.enum - schemas.Registration.properties.state.enumDescriptions - schemas.Registration.properties.supportedPrivacy.items.enumDescriptions - schemas.Registration.properties.transferFailureReason.description - schemas.RetrieveImportableDomainsResponse.description - schemas.RetrieveTransferParametersResponse.description - schemas.TransferDomainRequest.description - schemas.TransferParameters.description - schemas.TransferParameters.properties.supportedPrivacy.items.enumDescriptions #### domains:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.registrations.methods.export.deprecated - resources.projects.resources.locations.resources.registrations.methods.import.deprecated - resources.projects.resources.locations.resources.registrations.methods.retrieveImportableDomains.deprecated - resources.projects.resources.locations.resources.registrations.methods.retrieveTransferParameters.deprecated - resources.projects.resources.locations.resources.registrations.methods.transfer.deprecated - schemas.ContactSettings.properties.privacy.enumDeprecated - schemas.DnsSettings.properties.googleDomainsDns.deprecated - schemas.ExportRegistrationRequest.deprecated - schemas.GoogleDomainsDns.deprecated - schemas.ImportDomainRequest.deprecated - schemas.ManagementSettings.properties.preferredRenewalMethod.description - schemas.ManagementSettings.properties.preferredRenewalMethod.enum - schemas.ManagementSettings.properties.preferredRenewalMethod.enumDeprecated - schemas.ManagementSettings.properties.preferredRenewalMethod.enumDescriptions - schemas.ManagementSettings.properties.preferredRenewalMethod.type - schemas.ManagementSettings.properties.renewalMethod.enumDeprecated - schemas.RegisterParameters.properties.supportedPrivacy.items.enumDeprecated - schemas.Registration.properties.state.enumDeprecated - schemas.Registration.properties.supportedPrivacy.items.enumDeprecated - schemas.Registration.properties.transferFailureReason.deprecated - schemas.RetrieveImportableDomainsResponse.deprecated - schemas.RetrieveTransferParametersResponse.deprecated - schemas.TransferDomainRequest.deprecated - schemas.TransferParameters.deprecated - schemas.TransferParameters.properties.supportedPrivacy.items.enumDeprecated The following keys were changed: - resources.projects.resources.locations.resources.registrations.methods.delete.description - resources.projects.resources.locations.resources.registrations.methods.export.description - resources.projects.resources.locations.resources.registrations.methods.import.description - resources.projects.resources.locations.resources.registrations.methods.retrieveImportableDomains.description - resources.projects.resources.locations.resources.registrations.methods.retrieveTransferParameters.description - resources.projects.resources.locations.resources.registrations.methods.transfer.description - schemas.ContactSettings.properties.privacy.enumDescriptions - schemas.DnsSettings.properties.googleDomainsDns.description - schemas.ExportRegistrationRequest.description - schemas.GoogleDomainsDns.description - schemas.ImportDomainRequest.description - schemas.ManagementSettings.properties.renewalMethod.description - schemas.ManagementSettings.properties.renewalMethod.enum - schemas.ManagementSettings.properties.renewalMethod.enumDescriptions - schemas.RegisterParameters.properties.supportedPrivacy.items.enumDescriptions - schemas.Registration.description - schemas.Registration.properties.issues.items.enum - schemas.Registration.properties.issues.items.enumDescriptions - schemas.Registration.properties.state.enum - schemas.Registration.properties.state.enumDescriptions - schemas.Registration.properties.supportedPrivacy.items.enumDescriptions - schemas.Registration.properties.transferFailureReason.description - schemas.RetrieveImportableDomainsResponse.description - schemas.RetrieveTransferParametersResponse.description - schemas.TransferDomainRequest.description - schemas.TransferParameters.description - schemas.TransferParameters.properties.supportedPrivacy.items.enumDescriptions #### domains:v1 The following keys were added: - resources.projects.resources.locations.resources.registrations.methods.export.deprecated - resources.projects.resources.locations.resources.registrations.methods.import.deprecated - resources.projects.resources.locations.resources.registrations.methods.retrieveImportableDomains.deprecated - resources.projects.resources.locations.resources.registrations.methods.retrieveTransferParameters.deprecated - resources.projects.resources.locations.resources.registrations.methods.transfer.deprecated - schemas.ContactSettings.properties.privacy.enumDeprecated - schemas.DnsSettings.properties.googleDomainsDns.deprecated - schemas.ExportRegistrationRequest.deprecated - schemas.GoogleDomainsDns.deprecated - schemas.ImportDomainRequest.deprecated - schemas.ManagementSettings.properties.preferredRenewalMethod.description - schemas.ManagementSettings.properties.preferredRenewalMethod.enum - schemas.ManagementSettings.properties.preferredRenewalMethod.enumDeprecated - schemas.ManagementSettings.properties.preferredRenewalMethod.enumDescriptions - schemas.ManagementSettings.properties.preferredRenewalMethod.type - schemas.ManagementSettings.properties.renewalMethod.enumDeprecated - schemas.RegisterParameters.properties.supportedPrivacy.items.enumDeprecated - schemas.Registration.properties.state.enumDeprecated - schemas.Registration.properties.supportedPrivacy.items.enumDeprecated - schemas.Registration.properties.transferFailureReason.deprecated - schemas.RetrieveImportableDomainsResponse.deprecated - schemas.RetrieveTransferParametersResponse.deprecated - schemas.TransferDomainRequest.deprecated - schemas.TransferParameters.deprecated - schemas.TransferParameters.properties.supportedPrivacy.items.enumDeprecated The following keys were changed: - resources.projects.resources.locations.resources.registrations.methods.delete.description - resources.projects.resources.locations.resources.registrations.methods.export.description - resources.projects.resources.locations.resources.registrations.methods.import.description - resources.projects.resources.locations.resources.registrations.methods.retrieveImportableDomains.description - resources.projects.resources.locations.resources.registrations.methods.retrieveTransferParameters.description - resources.projects.resources.locations.resources.registrations.methods.transfer.description - schemas.ContactSettings.properties.privacy.enumDescriptions - schemas.DnsSettings.properties.googleDomainsDns.description - schemas.ExportRegistrationRequest.description - schemas.GoogleDomainsDns.description - schemas.ImportDomainRequest.description - schemas.ManagementSettings.properties.renewalMethod.description - schemas.ManagementSettings.properties.renewalMethod.enum - schemas.ManagementSettings.properties.renewalMethod.enumDescriptions - schemas.RegisterParameters.properties.supportedPrivacy.items.enumDescriptions - schemas.Registration.description - schemas.Registration.properties.issues.items.enum - schemas.Registration.properties.issues.items.enumDescriptions - schemas.Registration.properties.state.enum - schemas.Registration.properties.state.enumDescriptions - schemas.Registration.properties.supportedPrivacy.items.enumDescriptions - schemas.Registration.properties.transferFailureReason.description - schemas.RetrieveImportableDomainsResponse.description - schemas.RetrieveTransferParametersResponse.description - schemas.TransferDomainRequest.description - schemas.TransferParameters.description - schemas.TransferParameters.properties.supportedPrivacy.items.enumDescriptions
googleapis · Nov 27, 2023 · 057bd85 · 057bd85
1 parent 26935fe
commit 057bd85
Show file tree

Hide file tree

Showing 6 changed files with 417 additions and 153 deletions.
diff --git a/discovery/domains-v1.json b/discovery/domains-v1.json
diff --git a/discovery/domains-v1alpha2.json b/discovery/domains-v1alpha2.json
diff --git a/discovery/domains-v1beta1.json b/discovery/domains-v1beta1.json
diff --git a/src/apis/domains/v1.ts b/src/apis/domains/v1.ts
@@ -295,7 +295,7 @@ export namespace domains_v1 {
      */
     glueRecords?: Schema$GlueRecord[];
     /**
-     * The free DNS zone provided by [Google Domains](https://domains.google/).
+     * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) The free DNS zone provided by [Google Domains](https://domains.google/).
      */
     googleDomainsDns?: Schema$GoogleDomainsDns;
   }
@@ -338,7 +338,7 @@ export namespace domains_v1 {
     keyTag?: number | null;
   }
   /**
-   * Request for the `ExportRegistration` method.
+   * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `ExportRegistration` method.
    */
   export interface Schema$ExportRegistrationRequest {}
   /**
@@ -380,7 +380,7 @@ export namespace domains_v1 {
     ipv6Addresses?: string[] | null;
   }
   /**
-   * Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/).
+   * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/).
    */
   export interface Schema$GoogleDomainsDns {
     /**
@@ -397,7 +397,7 @@ export namespace domains_v1 {
     nameServers?: string[] | null;
   }
   /**
-   * Request for the `ImportDomain` method.
+   * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `ImportDomain` method.
    */
   export interface Schema$ImportDomainRequest {
     /**
@@ -478,7 +478,11 @@ export namespace domains_v1 {
    */
   export interface Schema$ManagementSettings {
     /**
-     * Output only. The renewal method for this `Registration`.
+     * Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, it will be treated as if it were set to `AUTOMATIC_RENEWAL`. Can't be set to `RENEWAL_DISABLED` during resource creation and can only be updated when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the `issues` field on the `Registration`. After the problem is resolved the `renewal_method` will be automatically updated to `preferred_renewal_method` in a few hours.
+     */
+    preferredRenewalMethod?: string | null;
+    /**
+     * Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual `renewal_method` can be equal to `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the `issues` field on the `Registration`. After the problem is resolved the `renewal_method` will be automatically updated to `preferred_renewal_method` in a few hours.
      */
     renewalMethod?: string | null;
     /**
@@ -678,7 +682,7 @@ export namespace domains_v1 {
     yearlyPrice?: Schema$Money;
   }
   /**
-   * 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`. 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.
+   * 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 (Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). 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`. Finally, you can create a new `Registration` by importing an existing domain managed with [Google Domains](https://domains.google/) (Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). 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.
    */
   export interface Schema$Registration {
     /**
@@ -734,7 +738,7 @@ export namespace domains_v1 {
      */
     supportedPrivacy?: string[] | null;
     /**
-     * Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.
+     * Output only. Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.
      */
     transferFailureReason?: string | null;
   }
@@ -743,7 +747,7 @@ export namespace domains_v1 {
    */
   export interface Schema$ResetAuthorizationCodeRequest {}
   /**
-   * Response for the `RetrieveImportableDomains` method.
+   * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Response for the `RetrieveImportableDomains` method.
    */
   export interface Schema$RetrieveImportableDomainsResponse {
     /**
@@ -765,7 +769,7 @@ export namespace domains_v1 {
     registerParameters?: Schema$RegisterParameters;
   }
   /**
-   * Response for the `RetrieveTransferParameters` method.
+   * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Response for the `RetrieveTransferParameters` method.
    */
   export interface Schema$RetrieveTransferParametersResponse {
     /**
@@ -831,7 +835,7 @@ export namespace domains_v1 {
     permissions?: string[] | null;
   }
   /**
-   * Request for the `TransferDomain` method.
+   * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `TransferDomain` method.
    */
   export interface Schema$TransferDomainRequest {
     /**
@@ -856,7 +860,7 @@ export namespace domains_v1 {
     yearlyPrice?: Schema$Money;
   }
   /**
-   * Parameters required to transfer a domain from another registrar.
+   * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Parameters required to transfer a domain from another registrar.
    */
   export interface Schema$TransferParameters {
     /**
@@ -1601,7 +1605,7 @@ export namespace domains_v1 {
     }
 
     /**
-     * Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. For `Registration` resources using [Monthly billing](/domains/pricing#billing-models), this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When an active registration 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 does not renew automatically unless the new owner sets up billing in Google Domains.
+     * Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. When an active registration 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 does not renew automatically unless the new owner sets up billing in Google Domains. After January 2024 you will only be able to delete `Registration` resources when `state` is one of: `EXPORTED`, `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) for more details.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1685,7 +1689,7 @@ export namespace domains_v1 {
     }
 
     /**
-     * Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, 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 does not renew automatically unless the new owner sets up billing in Google Domains.
+     * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, 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 does not renew automatically unless the new owner sets up billing in Google Domains.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1941,7 +1945,7 @@ export namespace domains_v1 {
     }
 
     /**
-     * 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.
+     * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) 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 params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2478,7 +2482,7 @@ export namespace domains_v1 {
     }
 
     /**
-     * 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 already managed by Cloud Domains are not returned.
+     * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) 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 already managed by Cloud Domains are not returned.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2672,7 +2676,7 @@ export namespace domains_v1 {
     }
 
     /**
-     * Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.
+     * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3046,7 +3050,7 @@ export namespace domains_v1 {
     }
 
     /**
-     * Transfers a domain name from another registrar to Cloud Domains. For domains 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.
+     * Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Transfers a domain name from another registrar to Cloud Domains. For domains 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 params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.