Skip to content

Commit 53fba76

Browse files
yoshi-automationyoshi-automation
committed
feat(domains): update the api
#### domains:v1 The following keys were added: - resources.projects.resources.locations.resources.registrations.methods.initiatePushTransfer (Total Keys: 12) - resources.projects.resources.locations.resources.registrations.methods.renewDomain (Total Keys: 12) - resources.projects.resources.locations.resources.registrations.methods.retrieveGoogleDomainsForwardingConfig (Total Keys: 11) - schemas.DomainForwarding (Total Keys: 8) - schemas.EmailForwarding (Total Keys: 4) - schemas.InitiatePushTransferRequest (Total Keys: 3) - schemas.ManagementSettings.properties.effectiveTransferLockState (Total Keys: 2) - schemas.Registration.properties.domainProperties (Total Keys: 3) - schemas.RenewDomainRequest (Total Keys: 4) - schemas.RetrieveGoogleDomainsForwardingConfigResponse (Total Keys: 6) #### domains:v1alpha2 The following keys were added: - resources.projects.resources.locations.resources.registrations.methods.initiatePushTransfer (Total Keys: 12) - resources.projects.resources.locations.resources.registrations.methods.renewDomain (Total Keys: 12) - resources.projects.resources.locations.resources.registrations.methods.retrieveGoogleDomainsForwardingConfig (Total Keys: 11) - schemas.DomainForwarding (Total Keys: 8) - schemas.EmailForwarding (Total Keys: 4) - schemas.InitiatePushTransferRequest (Total Keys: 3) - schemas.ManagementSettings.properties.effectiveTransferLockState (Total Keys: 2) - schemas.Registration.properties.domainProperties (Total Keys: 3) - schemas.RenewDomainRequest (Total Keys: 4) - schemas.RetrieveGoogleDomainsForwardingConfigResponse (Total Keys: 6) #### domains:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.registrations.methods.initiatePushTransfer (Total Keys: 12) - resources.projects.resources.locations.resources.registrations.methods.renewDomain (Total Keys: 12) - resources.projects.resources.locations.resources.registrations.methods.retrieveGoogleDomainsForwardingConfig (Total Keys: 11) - schemas.DomainForwarding (Total Keys: 8) - schemas.EmailForwarding (Total Keys: 4) - schemas.InitiatePushTransferRequest (Total Keys: 3) - schemas.ManagementSettings.properties.effectiveTransferLockState (Total Keys: 2) - schemas.Registration.properties.domainProperties (Total Keys: 3) - schemas.RenewDomainRequest (Total Keys: 4) - schemas.RetrieveGoogleDomainsForwardingConfigResponse (Total Keys: 6)
1 parent 40dd8f6 commit 53fba76

File tree

6 files changed

+1164
-48
lines changed

6 files changed

+1164
-48
lines changed

‎docs/dyn/domains_v1.projects.locations.registrations.html

Lines changed: 163 additions & 10 deletions
Large diffs are not rendered by default.

‎docs/dyn/domains_v1alpha2.projects.locations.registrations.html

Lines changed: 163 additions & 10 deletions
Large diffs are not rendered by default.

‎docs/dyn/domains_v1beta1.projects.locations.registrations.html

Lines changed: 163 additions & 10 deletions
Large diffs are not rendered by default.

‎googleapiclient/discovery_cache/documents/domains.v1.json

Lines changed: 225 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,34 @@
472472
"https://www.googleapis.com/auth/cloud-platform"
473473
]
474474
},
475+
"initiatePushTransfer": {
476+
"description": "Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).",
477+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:initiatePushTransfer",
478+
"httpMethod": "POST",
479+
"id": "domains.projects.locations.registrations.initiatePushTransfer",
480+
"parameterOrder": [
481+
"registration"
482+
],
483+
"parameters": {
484+
"registration": {
485+
"description": "Required. The name of the `Registration` for which the push transfer is initiated, in the format `projects/*/locations/*/registrations/*`.",
486+
"location": "path",
487+
"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$",
488+
"required": true,
489+
"type": "string"
490+
}
491+
},
492+
"path": "v1/{+registration}:initiatePushTransfer",
493+
"request": {
494+
"$ref": "InitiatePushTransferRequest"
495+
},
496+
"response": {
497+
"$ref": "Operation"
498+
},
499+
"scopes": [
500+
"https://www.googleapis.com/auth/cloud-platform"
501+
]
502+
},
475503
"list": {
476504
"description": "Lists the `Registration` resources in a project.",
477505
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations",
@@ -575,8 +603,36 @@
575603
"https://www.googleapis.com/auth/cloud-platform"
576604
]
577605
},
606+
"renewDomain": {
607+
"description": "Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.",
608+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:renewDomain",
609+
"httpMethod": "POST",
610+
"id": "domains.projects.locations.registrations.renewDomain",
611+
"parameterOrder": [
612+
"registration"
613+
],
614+
"parameters": {
615+
"registration": {
616+
"description": "Required. The name of the `Registration` whish is being renewed, in the format `projects/*/locations/*/registrations/*`.",
617+
"location": "path",
618+
"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$",
619+
"required": true,
620+
"type": "string"
621+
}
622+
},
623+
"path": "v1/{+registration}:renewDomain",
624+
"request": {
625+
"$ref": "RenewDomainRequest"
626+
},
627+
"response": {
628+
"$ref": "Operation"
629+
},
630+
"scopes": [
631+
"https://www.googleapis.com/auth/cloud-platform"
632+
]
633+
},
578634
"resetAuthorizationCode": {
579-
"description": "Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.",
635+
"description": "Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.",
580636
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:resetAuthorizationCode",
581637
"httpMethod": "POST",
582638
"id": "domains.projects.locations.registrations.resetAuthorizationCode",
@@ -604,7 +660,7 @@
604660
]
605661
},
606662
"retrieveAuthorizationCode": {
607-
"description": "Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.",
663+
"description": "Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.",
608664
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveAuthorizationCode",
609665
"httpMethod": "GET",
610666
"id": "domains.projects.locations.registrations.retrieveAuthorizationCode",
@@ -628,6 +684,31 @@
628684
"https://www.googleapis.com/auth/cloud-platform"
629685
]
630686
},
687+
"retrieveGoogleDomainsForwardingConfig": {
688+
"description": "Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.",
689+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveGoogleDomainsForwardingConfig",
690+
"httpMethod": "GET",
691+
"id": "domains.projects.locations.registrations.retrieveGoogleDomainsForwardingConfig",
692+
"parameterOrder": [
693+
"registration"
694+
],
695+
"parameters": {
696+
"registration": {
697+
"description": "Required. The name of the `Registration` whose Google Domains forwarding configuration details are being retrieved, in the format `projects/*/locations/*/registrations/*`.",
698+
"location": "path",
699+
"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$",
700+
"required": true,
701+
"type": "string"
702+
}
703+
},
704+
"path": "v1/{+registration}:retrieveGoogleDomainsForwardingConfig",
705+
"response": {
706+
"$ref": "RetrieveGoogleDomainsForwardingConfigResponse"
707+
},
708+
"scopes": [
709+
"https://www.googleapis.com/auth/cloud-platform"
710+
]
711+
},
631712
"retrieveImportableDomains": {
632713
"deprecated": true,
633714
"description": "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.",
@@ -848,7 +929,7 @@
848929
}
849930
}
850931
},
851-
"revision": "20240520",
932+
"revision": "20240603",
852933
"rootUrl": "https://domains.googleapis.com/",
853934
"schemas": {
854935
"AuditConfig": {
@@ -1146,6 +1227,47 @@ false
11461227
},
11471228
"type": "object"
11481229
},
1230+
"DomainForwarding": {
1231+
"description": "Domain forwarding configuration.",
1232+
"id": "DomainForwarding",
1233+
"properties": {
1234+
"pathForwarding": {
1235+
"description": "If true, forwards the path after the domain name to the same path at the new address.",
1236+
"type": "boolean"
1237+
},
1238+
"pemCertificate": {
1239+
"description": "The PEM-encoded certificate chain.",
1240+
"type": "string"
1241+
},
1242+
"redirectType": {
1243+
"description": "The redirect type.",
1244+
"enum": [
1245+
"REDIRECT_TYPE_UNSPECIFIED",
1246+
"TEMPORARY",
1247+
"PERMANENT"
1248+
],
1249+
"enumDescriptions": [
1250+
"Redirect Type is unspecified.",
1251+
"301 redirect. Allows to propagate changes to the forwarding address quickly.",
1252+
"302 redirect. Allows browsers to cache the forwarding address. This may help the address resolve more quickly. Changes may take longer to propagate"
1253+
],
1254+
"type": "string"
1255+
},
1256+
"sslEnabled": {
1257+
"description": "If true, the forwarding works also over HTTPS.",
1258+
"type": "boolean"
1259+
},
1260+
"subdomain": {
1261+
"description": "The subdomain of the registered domain that is being forwarded. E.g. `www.example.com`, `example.com` (i.e. the registered domain itself) or `*.example.com` (i.e. all subdomains).",
1262+
"type": "string"
1263+
},
1264+
"targetUri": {
1265+
"description": "The target of the domain forwarding, i.e. the path to redirect the `subdomain` to.",
1266+
"type": "string"
1267+
}
1268+
},
1269+
"type": "object"
1270+
},
11491271
"DsRecord": {
11501272
"description": "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.",
11511273
"id": "DsRecord",
@@ -1224,6 +1346,21 @@ false
12241346
},
12251347
"type": "object"
12261348
},
1349+
"EmailForwarding": {
1350+
"description": "Email forwarding configuration.",
1351+
"id": "EmailForwarding",
1352+
"properties": {
1353+
"alias": {
1354+
"description": "An alias recipient email that forwards emails to the `target_email_address`. For example, `[email protected]` or `*@example.com` (wildcard alias forwards all the emails under the registered domain).",
1355+
"type": "string"
1356+
},
1357+
"targetEmailAddress": {
1358+
"description": "Target email that receives emails sent to the `alias`.",
1359+
"type": "string"
1360+
}
1361+
},
1362+
"type": "object"
1363+
},
12271364
"ExportRegistrationRequest": {
12281365
"deprecated": true,
12291366
"description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). Request for the `ExportRegistration` method.",
@@ -1336,6 +1473,17 @@ false
13361473
},
13371474
"type": "object"
13381475
},
1476+
"InitiatePushTransferRequest": {
1477+
"description": "Request for the `InitiatePushTransfer` method.",
1478+
"id": "InitiatePushTransferRequest",
1479+
"properties": {
1480+
"tag": {
1481+
"description": "Required. The Tag of the new registrar. Can be found at [List of registrars](https://nominet.uk/registrar-list/).",
1482+
"type": "string"
1483+
}
1484+
},
1485+
"type": "object"
1486+
},
13391487
"ListLocationsResponse": {
13401488
"description": "The response message for Locations.ListLocations.",
13411489
"id": "ListLocationsResponse",
@@ -1428,6 +1576,21 @@ false
14281576
"description": "Defines renewal, billing, and transfer settings for a `Registration`.",
14291577
"id": "ManagementSettings",
14301578
"properties": {
1579+
"effectiveTransferLockState": {
1580+
"description": "Output only. The actual transfer lock state for this `Registration`.",
1581+
"enum": [
1582+
"TRANSFER_LOCK_STATE_UNSPECIFIED",
1583+
"UNLOCKED",
1584+
"LOCKED"
1585+
],
1586+
"enumDescriptions": [
1587+
"The state is unspecified.",
1588+
"The domain is unlocked and can be transferred to another registrar.",
1589+
"The domain is locked and cannot be transferred to another registrar."
1590+
],
1591+
"readOnly": true,
1592+
"type": "string"
1593+
},
14311594
"preferredRenewalMethod": {
14321595
"description": "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`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only 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 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` is automatically updated to `preferred_renewal_method` in a few hours.",
14331596
"enum": [
@@ -1474,7 +1637,7 @@ false
14741637
"type": "string"
14751638
},
14761639
"transferLockState": {
1477-
"description": "This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar.",
1640+
"description": "This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state.",
14781641
"enum": [
14791642
"TRANSFER_LOCK_STATE_UNSPECIFIED",
14801643
"UNLOCKED",
@@ -1812,6 +1975,24 @@ false
18121975
"description": "Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.",
18131976
"type": "string"
18141977
},
1978+
"domainProperties": {
1979+
"description": "Output only. Special properties of the domain.",
1980+
"items": {
1981+
"enum": [
1982+
"DOMAIN_PROPERTY_UNSPECIFIED",
1983+
"TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY",
1984+
"REQUIRE_PUSH_TRANSFER"
1985+
],
1986+
"enumDescriptions": [
1987+
"The property is undefined.",
1988+
"The domain does not support transfer locks due to restrictions of the registry. Such domains are effectively always unlocked and any change made to `management_settings.transfer_lock_state` is ignored.",
1989+
"The domain uses an alternative `Push Transfer` process to transfer the domain to another registrar. There are two important consequences: * Cloud Domains does not supply the authorization codes. * To initiate the process to transfer the domain to another registrar, you must provide a tag of the registrar you want to transfer to. You can do this by using the `InitiatePushTransfer` method. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar)."
1990+
],
1991+
"type": "string"
1992+
},
1993+
"readOnly": true,
1994+
"type": "array"
1995+
},
18151996
"expireTime": {
18161997
"description": "Output only. The expiration timestamp of the `Registration`.",
18171998
"format": "google-datetime",
@@ -1825,13 +2006,15 @@ false
18252006
"ISSUE_UNSPECIFIED",
18262007
"CONTACT_SUPPORT",
18272008
"UNVERIFIED_EMAIL",
1828-
"PROBLEM_WITH_BILLING"
2009+
"PROBLEM_WITH_BILLING",
2010+
"DNS_NOT_ACTIVATED"
18292011
],
18302012
"enumDescriptions": [
18312013
"The issue is undefined.",
18322014
"Contact the Cloud Support team to resolve a problem with this domain.",
18332015
"[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.",
1834-
"The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account."
2016+
"The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.",
2017+
"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation."
18352018
],
18362019
"type": "string"
18372020
},
@@ -1978,12 +2161,48 @@ false
19782161
},
19792162
"type": "object"
19802163
},
2164+
"RenewDomainRequest": {
2165+
"description": "Request for the `RenewDomain` method.",
2166+
"id": "RenewDomainRequest",
2167+
"properties": {
2168+
"validateOnly": {
2169+
"description": "Optional. When true, only validation is performed, without actually renewing the domain. For more information, see [Request validation](https://cloud.google.com/apis/design/design_patterns#request_validation)",
2170+
"type": "boolean"
2171+
},
2172+
"yearlyPrice": {
2173+
"$ref": "Money",
2174+
"description": "Required. Acknowledgement of the price to renew the domain for one year. To get the price, see [Cloud Domains pricing](https://cloud.google.com/domains/pricing). If not provided, the expected price is returned in the error message."
2175+
}
2176+
},
2177+
"type": "object"
2178+
},
19812179
"ResetAuthorizationCodeRequest": {
19822180
"description": "Request for the `ResetAuthorizationCode` method.",
19832181
"id": "ResetAuthorizationCodeRequest",
19842182
"properties": {},
19852183
"type": "object"
19862184
},
2185+
"RetrieveGoogleDomainsForwardingConfigResponse": {
2186+
"description": "Response for the `RetrieveGoogleDomainsForwardingConfig` method.",
2187+
"id": "RetrieveGoogleDomainsForwardingConfigResponse",
2188+
"properties": {
2189+
"domainForwardings": {
2190+
"description": "The list of domain forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.",
2191+
"items": {
2192+
"$ref": "DomainForwarding"
2193+
},
2194+
"type": "array"
2195+
},
2196+
"emailForwardings": {
2197+
"description": "The list of email forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.",
2198+
"items": {
2199+
"$ref": "EmailForwarding"
2200+
},
2201+
"type": "array"
2202+
}
2203+
},
2204+
"type": "object"
2205+
},
19872206
"RetrieveImportableDomainsResponse": {
19882207
"deprecated": true,
19892208
"description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). Response for the `RetrieveImportableDomains` method.",

0 commit comments

Comments
 (0)