google-apis-domains_v1alpha2 0.7.0 → 0.11.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d51e3726b177451c9fe2da621258eeb43f27c69da8428272719b9edce0647680
4
- data.tar.gz: 115ba1b1e4831bd98a042c097e332ae289629c1802de36171fc9f2550c40a348
3
+ metadata.gz: ef1a14a7731bcbe099c35c953105cc5f18853f14a782619213dfd08103381e1b
4
+ data.tar.gz: 46c269886b265e62274596cf6d5acf8a9f6351b0f2a90252a28c68ebce7e4526
5
5
  SHA512:
6
- metadata.gz: 0ad559ab1ee69c868535dd15f02893be966be5c2bd4ae411ae4e86d2723429406f358545c389fc8fe6efb7d0a056f7a3f76b56f64be241e239de6ec2d9fea1b2
7
- data.tar.gz: a4c9ed1b0df2f9f58fa198ee545def72dacb4384a298892cbced996bfa6ac98bb507abca399ea0aeaf294592c3d7967556c1c676e7089b1602e72990929a3997
6
+ metadata.gz: 35c453add1f8d4eb94104fcefe5a95b67999c36d4f617954e5ab9bcfa0c48a5f32dd05719808251c5b17e90e390df44e427a1590763807b6b7766e76a0a6a464
7
+ data.tar.gz: 329572da2dc44e65e199b27ed7aef5816d4dbed1ab7a6a5fc88fca126c64668ec8c57048ef62d3202ba7e3387af96cb198f860540e88d5c479a715e22383a2cc
data/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Release history for google-apis-domains_v1alpha2
2
2
 
3
+ ### v0.11.0 (2021-11-13)
4
+
5
+ * Regenerated from discovery document revision 20211108
6
+
7
+ ### v0.10.0 (2021-10-24)
8
+
9
+ * Regenerated from discovery document revision 20211019
10
+ * Unspecified changes
11
+
12
+ ### v0.9.0 (2021-10-09)
13
+
14
+ * Regenerated from discovery document revision 20211004
15
+
16
+ ### v0.8.0 (2021-10-03)
17
+
18
+ * Regenerated from discovery document revision 20210927
19
+
3
20
  ### v0.7.0 (2021-06-29)
4
21
 
5
22
  * Regenerated using generator version 0.4.0
data/OVERVIEW.md CHANGED
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
60
60
 
61
61
  More detailed descriptions of the Google simple REST clients are available in two documents.
62
62
 
63
- * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
- * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Domains service in particular.)
67
67
 
@@ -113,7 +113,7 @@ module Google
113
113
  end
114
114
  end
115
115
 
116
- # Associates `members` with a `role`.
116
+ # Associates `members`, or principals, with a `role`.
117
117
  class Binding
118
118
  include Google::Apis::Core::Hashable
119
119
 
@@ -136,7 +136,7 @@ module Google
136
136
  # @return [Google::Apis::DomainsV1alpha2::Expr]
137
137
  attr_accessor :condition
138
138
 
139
- # Specifies the identities requesting access for a Cloud Platform resource. `
139
+ # Specifies the principals requesting access for a Cloud Platform resource. `
140
140
  # members` can have the following values: * `allUsers`: A special identifier
141
141
  # that represents anyone who is on the internet; with or without a Google
142
142
  # account. * `allAuthenticatedUsers`: A special identifier that represents
@@ -166,8 +166,8 @@ module Google
166
166
  # @return [Array<String>]
167
167
  attr_accessor :members
168
168
 
169
- # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`
170
- # , or `roles/owner`.
169
+ # Role that is assigned to the list of `members`, or principals. For example, `
170
+ # roles/viewer`, `roles/editor`, or `roles/owner`.
171
171
  # Corresponds to the JSON property `role`
172
172
  # @return [String]
173
173
  attr_accessor :role
@@ -204,7 +204,7 @@ module Google
204
204
 
205
205
  # Required. The field mask describing which fields to update as a comma-
206
206
  # separated list. For example, if only the registrant contact is being updated,
207
- # the `update_mask` would be `"registrant_contact"`.
207
+ # the `update_mask` is `"registrant_contact"`.
208
208
  # Corresponds to the JSON property `updateMask`
209
209
  # @return [String]
210
210
  attr_accessor :update_mask
@@ -240,11 +240,11 @@ module Google
240
240
 
241
241
  # Required. The field mask describing which fields to update as a comma-
242
242
  # separated list. For example, if only the name servers are being updated for an
243
- # existing Custom DNS configuration, the `update_mask` would be `"custom_dns.
243
+ # existing Custom DNS configuration, the `update_mask` is `"custom_dns.
244
244
  # name_servers"`. When changing the DNS provider from one type to another, pass
245
245
  # the new provider's field name as part of the field mask. For example, when
246
246
  # changing from a Google Domains DNS configuration to a Custom DNS configuration,
247
- # the `update_mask` would be `"custom_dns"`. //
247
+ # the `update_mask` is `"custom_dns"`. //
248
248
  # Corresponds to the JSON property `updateMask`
249
249
  # @return [String]
250
250
  attr_accessor :update_mask
@@ -278,7 +278,7 @@ module Google
278
278
 
279
279
  # Required. The field mask describing which fields to update as a comma-
280
280
  # separated list. For example, if only the transfer lock is being updated, the `
281
- # update_mask` would be `"transfer_lock_state"`.
281
+ # update_mask` is `"transfer_lock_state"`.
282
282
  # Corresponds to the JSON property `updateMask`
283
283
  # @return [String]
284
284
  attr_accessor :update_mask
@@ -928,31 +928,31 @@ module Google
928
928
 
929
929
  # An Identity and Access Management (IAM) policy, which specifies access
930
930
  # controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
931
- # A `binding` binds one or more `members` to a single `role`. Members can be
932
- # user accounts, service accounts, Google groups, and domains (such as G Suite).
933
- # A `role` is a named list of permissions; each `role` can be an IAM predefined
934
- # role or a user-created custom role. For some types of Google Cloud resources,
935
- # a `binding` can also specify a `condition`, which is a logical expression that
936
- # allows access to a resource only if the expression evaluates to `true`. A
937
- # condition can add constraints based on attributes of the request, the resource,
938
- # or both. To learn which resources support conditions in their IAM policies,
939
- # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
940
- # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/
941
- # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "
942
- # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@
943
- # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager.
944
- # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` "
945
- # title": "expirable access", "description": "Does not grant access after Sep
946
- # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", `
947
- # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: -
948
- # members: - user:mike@example.com - group:admins@example.com - domain:google.
949
- # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/
950
- # resourcemanager.organizationAdmin - members: - user:eve@example.com role:
951
- # roles/resourcemanager.organizationViewer condition: title: expirable access
952
- # description: Does not grant access after Sep 2020 expression: request.time <
953
- # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a
954
- # description of IAM and its features, see the [IAM documentation](https://cloud.
955
- # google.com/iam/docs/).
931
+ # A `binding` binds one or more `members`, or principals, to a single `role`.
932
+ # Principals can be user accounts, service accounts, Google groups, and domains (
933
+ # such as G Suite). A `role` is a named list of permissions; each `role` can be
934
+ # an IAM predefined role or a user-created custom role. For some types of Google
935
+ # Cloud resources, a `binding` can also specify a `condition`, which is a
936
+ # logical expression that allows access to a resource only if the expression
937
+ # evaluates to `true`. A condition can add constraints based on attributes of
938
+ # the request, the resource, or both. To learn which resources support
939
+ # conditions in their IAM policies, see the [IAM documentation](https://cloud.
940
+ # google.com/iam/help/conditions/resource-policies). **JSON example:** ` "
941
+ # bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members": [
942
+ # "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
943
+ # serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
944
+ # roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
945
+ # ], "condition": ` "title": "expirable access", "description": "Does not grant
946
+ # access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
947
+ # 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:**
948
+ # bindings: - members: - user:mike@example.com - group:admins@example.com -
949
+ # domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
950
+ # role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
951
+ # com role: roles/resourcemanager.organizationViewer condition: title: expirable
952
+ # access description: Does not grant access after Sep 2020 expression: request.
953
+ # time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For
954
+ # a description of IAM and its features, see the [IAM documentation](https://
955
+ # cloud.google.com/iam/docs/).
956
956
  class Policy
957
957
  include Google::Apis::Core::Hashable
958
958
 
@@ -961,9 +961,14 @@ module Google
961
961
  # @return [Array<Google::Apis::DomainsV1alpha2::AuditConfig>]
962
962
  attr_accessor :audit_configs
963
963
 
964
- # Associates a list of `members` to a `role`. Optionally, may specify a `
965
- # condition` that determines how and when the `bindings` are applied. Each of
966
- # the `bindings` must contain at least one member.
964
+ # Associates a list of `members`, or principals, with a `role`. Optionally, may
965
+ # specify a `condition` that determines how and when the `bindings` are applied.
966
+ # Each of the `bindings` must contain at least one principal. The `bindings` in
967
+ # a `Policy` can refer to up to 1,500 principals; up to 250 of these principals
968
+ # can be Google groups. Each occurrence of a principal counts towards these
969
+ # limits. For example, if the `bindings` grant 50 different roles to `user:alice@
970
+ # example.com`, and not to any other principal, then you can add another 1,450
971
+ # principals to the `bindings` in the `Policy`.
967
972
  # Corresponds to the JSON property `bindings`
968
973
  # @return [Array<Google::Apis::DomainsV1alpha2::Binding>]
969
974
  attr_accessor :bindings
@@ -1166,16 +1171,22 @@ module Google
1166
1171
  attr_accessor :domain_notices
1167
1172
 
1168
1173
  # The `Registration` resource facilitates managing and configuring domain name
1169
- # registrations. To create a new `Registration` resource, find a suitable domain
1170
- # name by calling the `SearchDomains` method with a query to see available
1171
- # domain name options. After choosing a name, call `RetrieveRegisterParameters`
1172
- # to ensure availability and obtain information like pricing, which is needed to
1173
- # build a call to `RegisterDomain`.
1174
+ # registrations. There are several ways to create a new `Registration` resource:
1175
+ # To create a new `Registration` resource, find a suitable domain name by
1176
+ # calling the `SearchDomains` method with a query to see available domain name
1177
+ # options. After choosing a name, call `RetrieveRegisterParameters` to ensure
1178
+ # availability and obtain information like pricing, which is needed to build a
1179
+ # call to `RegisterDomain`. Another way to create a new `Registration` is to
1180
+ # transfer an existing domain from another registrar. First, go to the current
1181
+ # registrar to unlock the domain for transfer and retrieve the domain's transfer
1182
+ # authorization code. Then call `RetrieveTransferParameters` to confirm that the
1183
+ # domain is unlocked and to get values needed to build a call to `TransferDomain`
1184
+ # .
1174
1185
  # Corresponds to the JSON property `registration`
1175
1186
  # @return [Google::Apis::DomainsV1alpha2::Registration]
1176
1187
  attr_accessor :registration
1177
1188
 
1178
- # When true, only validation will be performed, without actually registering the
1189
+ # When true, only validation is performed, without actually registering the
1179
1190
  # domain. Follows: https://cloud.google.com/apis/design/design_patterns#
1180
1191
  # request_validation
1181
1192
  # Corresponds to the JSON property `validateOnly`
@@ -1248,11 +1259,17 @@ module Google
1248
1259
  end
1249
1260
 
1250
1261
  # The `Registration` resource facilitates managing and configuring domain name
1251
- # registrations. To create a new `Registration` resource, find a suitable domain
1252
- # name by calling the `SearchDomains` method with a query to see available
1253
- # domain name options. After choosing a name, call `RetrieveRegisterParameters`
1254
- # to ensure availability and obtain information like pricing, which is needed to
1255
- # build a call to `RegisterDomain`.
1262
+ # registrations. There are several ways to create a new `Registration` resource:
1263
+ # To create a new `Registration` resource, find a suitable domain name by
1264
+ # calling the `SearchDomains` method with a query to see available domain name
1265
+ # options. After choosing a name, call `RetrieveRegisterParameters` to ensure
1266
+ # availability and obtain information like pricing, which is needed to build a
1267
+ # call to `RegisterDomain`. Another way to create a new `Registration` is to
1268
+ # transfer an existing domain from another registrar. First, go to the current
1269
+ # registrar to unlock the domain for transfer and retrieve the domain's transfer
1270
+ # authorization code. Then call `RetrieveTransferParameters` to confirm that the
1271
+ # domain is unlocked and to get values needed to build a call to `TransferDomain`
1272
+ # .
1256
1273
  class Registration
1257
1274
  include Google::Apis::Core::Hashable
1258
1275
 
@@ -1379,6 +1396,25 @@ module Google
1379
1396
  end
1380
1397
  end
1381
1398
 
1399
+ # Response for the `RetrieveTransferParameters` method.
1400
+ class RetrieveTransferParametersResponse
1401
+ include Google::Apis::Core::Hashable
1402
+
1403
+ # Parameters required to transfer a domain from another registrar.
1404
+ # Corresponds to the JSON property `transferParameters`
1405
+ # @return [Google::Apis::DomainsV1alpha2::TransferParameters]
1406
+ attr_accessor :transfer_parameters
1407
+
1408
+ def initialize(**args)
1409
+ update!(**args)
1410
+ end
1411
+
1412
+ # Update properties of this object
1413
+ def update!(**args)
1414
+ @transfer_parameters = args[:transfer_parameters] if args.key?(:transfer_parameters)
1415
+ end
1416
+ end
1417
+
1382
1418
  # Response for the `SearchDomains` method.
1383
1419
  class SearchDomainsResponse
1384
1420
  include Google::Apis::Core::Hashable
@@ -1404,31 +1440,31 @@ module Google
1404
1440
 
1405
1441
  # An Identity and Access Management (IAM) policy, which specifies access
1406
1442
  # controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
1407
- # A `binding` binds one or more `members` to a single `role`. Members can be
1408
- # user accounts, service accounts, Google groups, and domains (such as G Suite).
1409
- # A `role` is a named list of permissions; each `role` can be an IAM predefined
1410
- # role or a user-created custom role. For some types of Google Cloud resources,
1411
- # a `binding` can also specify a `condition`, which is a logical expression that
1412
- # allows access to a resource only if the expression evaluates to `true`. A
1413
- # condition can add constraints based on attributes of the request, the resource,
1414
- # or both. To learn which resources support conditions in their IAM policies,
1415
- # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
1416
- # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/
1417
- # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "
1418
- # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@
1419
- # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager.
1420
- # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` "
1421
- # title": "expirable access", "description": "Does not grant access after Sep
1422
- # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", `
1423
- # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: -
1424
- # members: - user:mike@example.com - group:admins@example.com - domain:google.
1425
- # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/
1426
- # resourcemanager.organizationAdmin - members: - user:eve@example.com role:
1427
- # roles/resourcemanager.organizationViewer condition: title: expirable access
1428
- # description: Does not grant access after Sep 2020 expression: request.time <
1429
- # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a
1430
- # description of IAM and its features, see the [IAM documentation](https://cloud.
1431
- # google.com/iam/docs/).
1443
+ # A `binding` binds one or more `members`, or principals, to a single `role`.
1444
+ # Principals can be user accounts, service accounts, Google groups, and domains (
1445
+ # such as G Suite). A `role` is a named list of permissions; each `role` can be
1446
+ # an IAM predefined role or a user-created custom role. For some types of Google
1447
+ # Cloud resources, a `binding` can also specify a `condition`, which is a
1448
+ # logical expression that allows access to a resource only if the expression
1449
+ # evaluates to `true`. A condition can add constraints based on attributes of
1450
+ # the request, the resource, or both. To learn which resources support
1451
+ # conditions in their IAM policies, see the [IAM documentation](https://cloud.
1452
+ # google.com/iam/help/conditions/resource-policies). **JSON example:** ` "
1453
+ # bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members": [
1454
+ # "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
1455
+ # serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
1456
+ # roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
1457
+ # ], "condition": ` "title": "expirable access", "description": "Does not grant
1458
+ # access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
1459
+ # 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:**
1460
+ # bindings: - members: - user:mike@example.com - group:admins@example.com -
1461
+ # domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
1462
+ # role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
1463
+ # com role: roles/resourcemanager.organizationViewer condition: title: expirable
1464
+ # access description: Does not grant access after Sep 2020 expression: request.
1465
+ # time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For
1466
+ # a description of IAM and its features, see the [IAM documentation](https://
1467
+ # cloud.google.com/iam/docs/).
1432
1468
  # Corresponds to the JSON property `policy`
1433
1469
  # @return [Google::Apis::DomainsV1alpha2::Policy]
1434
1470
  attr_accessor :policy
@@ -1529,6 +1565,113 @@ module Google
1529
1565
  @permissions = args[:permissions] if args.key?(:permissions)
1530
1566
  end
1531
1567
  end
1568
+
1569
+ # Request for the `TransferDomain` method.
1570
+ class TransferDomainRequest
1571
+ include Google::Apis::Core::Hashable
1572
+
1573
+ # Defines an authorization code.
1574
+ # Corresponds to the JSON property `authorizationCode`
1575
+ # @return [Google::Apis::DomainsV1alpha2::AuthorizationCode]
1576
+ attr_accessor :authorization_code
1577
+
1578
+ # The list of contact notices that you acknowledge. The notices needed here
1579
+ # depend on the values specified in `registration.contact_settings`.
1580
+ # Corresponds to the JSON property `contactNotices`
1581
+ # @return [Array<String>]
1582
+ attr_accessor :contact_notices
1583
+
1584
+ # The `Registration` resource facilitates managing and configuring domain name
1585
+ # registrations. There are several ways to create a new `Registration` resource:
1586
+ # To create a new `Registration` resource, find a suitable domain name by
1587
+ # calling the `SearchDomains` method with a query to see available domain name
1588
+ # options. After choosing a name, call `RetrieveRegisterParameters` to ensure
1589
+ # availability and obtain information like pricing, which is needed to build a
1590
+ # call to `RegisterDomain`. Another way to create a new `Registration` is to
1591
+ # transfer an existing domain from another registrar. First, go to the current
1592
+ # registrar to unlock the domain for transfer and retrieve the domain's transfer
1593
+ # authorization code. Then call `RetrieveTransferParameters` to confirm that the
1594
+ # domain is unlocked and to get values needed to build a call to `TransferDomain`
1595
+ # .
1596
+ # Corresponds to the JSON property `registration`
1597
+ # @return [Google::Apis::DomainsV1alpha2::Registration]
1598
+ attr_accessor :registration
1599
+
1600
+ # Validate the request without actually transferring the domain.
1601
+ # Corresponds to the JSON property `validateOnly`
1602
+ # @return [Boolean]
1603
+ attr_accessor :validate_only
1604
+ alias_method :validate_only?, :validate_only
1605
+
1606
+ # Represents an amount of money with its currency type.
1607
+ # Corresponds to the JSON property `yearlyPrice`
1608
+ # @return [Google::Apis::DomainsV1alpha2::Money]
1609
+ attr_accessor :yearly_price
1610
+
1611
+ def initialize(**args)
1612
+ update!(**args)
1613
+ end
1614
+
1615
+ # Update properties of this object
1616
+ def update!(**args)
1617
+ @authorization_code = args[:authorization_code] if args.key?(:authorization_code)
1618
+ @contact_notices = args[:contact_notices] if args.key?(:contact_notices)
1619
+ @registration = args[:registration] if args.key?(:registration)
1620
+ @validate_only = args[:validate_only] if args.key?(:validate_only)
1621
+ @yearly_price = args[:yearly_price] if args.key?(:yearly_price)
1622
+ end
1623
+ end
1624
+
1625
+ # Parameters required to transfer a domain from another registrar.
1626
+ class TransferParameters
1627
+ include Google::Apis::Core::Hashable
1628
+
1629
+ # The registrar that currently manages the domain.
1630
+ # Corresponds to the JSON property `currentRegistrar`
1631
+ # @return [String]
1632
+ attr_accessor :current_registrar
1633
+
1634
+ # The domain name. Unicode domain names are expressed in Punycode format.
1635
+ # Corresponds to the JSON property `domainName`
1636
+ # @return [String]
1637
+ attr_accessor :domain_name
1638
+
1639
+ # The name servers that currently store the configuration of the domain.
1640
+ # Corresponds to the JSON property `nameServers`
1641
+ # @return [Array<String>]
1642
+ attr_accessor :name_servers
1643
+
1644
+ # Contact privacy options that the domain supports.
1645
+ # Corresponds to the JSON property `supportedPrivacy`
1646
+ # @return [Array<String>]
1647
+ attr_accessor :supported_privacy
1648
+
1649
+ # Indicates whether the domain is protected by a transfer lock. For a transfer
1650
+ # to succeed, this must show `UNLOCKED`. To unlock a domain, go to its current
1651
+ # registrar.
1652
+ # Corresponds to the JSON property `transferLockState`
1653
+ # @return [String]
1654
+ attr_accessor :transfer_lock_state
1655
+
1656
+ # Represents an amount of money with its currency type.
1657
+ # Corresponds to the JSON property `yearlyPrice`
1658
+ # @return [Google::Apis::DomainsV1alpha2::Money]
1659
+ attr_accessor :yearly_price
1660
+
1661
+ def initialize(**args)
1662
+ update!(**args)
1663
+ end
1664
+
1665
+ # Update properties of this object
1666
+ def update!(**args)
1667
+ @current_registrar = args[:current_registrar] if args.key?(:current_registrar)
1668
+ @domain_name = args[:domain_name] if args.key?(:domain_name)
1669
+ @name_servers = args[:name_servers] if args.key?(:name_servers)
1670
+ @supported_privacy = args[:supported_privacy] if args.key?(:supported_privacy)
1671
+ @transfer_lock_state = args[:transfer_lock_state] if args.key?(:transfer_lock_state)
1672
+ @yearly_price = args[:yearly_price] if args.key?(:yearly_price)
1673
+ end
1674
+ end
1532
1675
  end
1533
1676
  end
1534
1677
  end
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DomainsV1alpha2
18
18
  # Version of the google-apis-domains_v1alpha2 gem
19
- GEM_VERSION = "0.7.0"
19
+ GEM_VERSION = "0.11.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210412"
25
+ REVISION = "20211108"
26
26
  end
27
27
  end
28
28
  end
@@ -208,6 +208,12 @@ module Google
208
208
  include Google::Apis::Core::JsonObjectSupport
209
209
  end
210
210
 
211
+ class RetrieveTransferParametersResponse
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
211
217
  class SearchDomainsResponse
212
218
  class Representation < Google::Apis::Core::JsonRepresentation; end
213
219
 
@@ -238,6 +244,18 @@ module Google
238
244
  include Google::Apis::Core::JsonObjectSupport
239
245
  end
240
246
 
247
+ class TransferDomainRequest
248
+ class Representation < Google::Apis::Core::JsonRepresentation; end
249
+
250
+ include Google::Apis::Core::JsonObjectSupport
251
+ end
252
+
253
+ class TransferParameters
254
+ class Representation < Google::Apis::Core::JsonRepresentation; end
255
+
256
+ include Google::Apis::Core::JsonObjectSupport
257
+ end
258
+
241
259
  class AuditConfig
242
260
  # @private
243
261
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -561,6 +579,14 @@ module Google
561
579
  end
562
580
  end
563
581
 
582
+ class RetrieveTransferParametersResponse
583
+ # @private
584
+ class Representation < Google::Apis::Core::JsonRepresentation
585
+ property :transfer_parameters, as: 'transferParameters', class: Google::Apis::DomainsV1alpha2::TransferParameters, decorator: Google::Apis::DomainsV1alpha2::TransferParameters::Representation
586
+
587
+ end
588
+ end
589
+
564
590
  class SearchDomainsResponse
565
591
  # @private
566
592
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -600,6 +626,33 @@ module Google
600
626
  collection :permissions, as: 'permissions'
601
627
  end
602
628
  end
629
+
630
+ class TransferDomainRequest
631
+ # @private
632
+ class Representation < Google::Apis::Core::JsonRepresentation
633
+ property :authorization_code, as: 'authorizationCode', class: Google::Apis::DomainsV1alpha2::AuthorizationCode, decorator: Google::Apis::DomainsV1alpha2::AuthorizationCode::Representation
634
+
635
+ collection :contact_notices, as: 'contactNotices'
636
+ property :registration, as: 'registration', class: Google::Apis::DomainsV1alpha2::Registration, decorator: Google::Apis::DomainsV1alpha2::Registration::Representation
637
+
638
+ property :validate_only, as: 'validateOnly'
639
+ property :yearly_price, as: 'yearlyPrice', class: Google::Apis::DomainsV1alpha2::Money, decorator: Google::Apis::DomainsV1alpha2::Money::Representation
640
+
641
+ end
642
+ end
643
+
644
+ class TransferParameters
645
+ # @private
646
+ class Representation < Google::Apis::Core::JsonRepresentation
647
+ property :current_registrar, as: 'currentRegistrar'
648
+ property :domain_name, as: 'domainName'
649
+ collection :name_servers, as: 'nameServers'
650
+ collection :supported_privacy, as: 'supportedPrivacy'
651
+ property :transfer_lock_state, as: 'transferLockState'
652
+ property :yearly_price, as: 'yearlyPrice', class: Google::Apis::DomainsV1alpha2::Money, decorator: Google::Apis::DomainsV1alpha2::Money::Representation
653
+
654
+ end
655
+ end
603
656
  end
604
657
  end
605
658
  end
@@ -302,9 +302,17 @@ module Google
302
302
  execute_or_queue_command(command, &block)
303
303
  end
304
304
 
305
- # Deletes a `Registration` resource. This method only works on resources in one
306
- # of the following states: * `state` is `EXPORTED` with `expire_time` in the
307
- # past * `state` is `REGISTRATION_FAILED`
305
+ # Deletes a `Registration` resource. This method works on any `Registration`
306
+ # resource using [Subscription or Commitment billing](/domains/pricing#billing-
307
+ # models), provided that the resource was created at least 1 day in the past.
308
+ # For `Registration` resources using [Monthly billing](/domains/pricing#billing-
309
+ # models), this method works if: * `state` is `EXPORTED` with `expire_time` in
310
+ # the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED`
311
+ # When an active registration is successfully deleted, you can continue to use
312
+ # the domain in [Google Domains](https://domains.google/) until it expires. The
313
+ # calling user becomes the domain's sole owner in Google Domains, and
314
+ # permissions for the domain are subsequently managed there. The domain does not
315
+ # renew automatically unless the new owner sets up billing in Google Domains.
308
316
  # @param [String] name
309
317
  # Required. The name of the `Registration` to delete, in the format `projects/*/
310
318
  # locations/*/registrations/*`.
@@ -335,15 +343,12 @@ module Google
335
343
  execute_or_queue_command(command, &block)
336
344
  end
337
345
 
338
- # Exports a `Registration` that you no longer want to use with Cloud Domains.
339
- # You can continue to use the domain in [Google Domains](https://domains.google/)
340
- # until it expires. If the export is successful: * The resource's `state`
341
- # becomes `EXPORTED`, meaning that it is no longer managed by Cloud Domains *
342
- # Because individual users can own domains in Google Domains, the calling user
343
- # becomes the domain's sole owner. Permissions for the domain are subsequently
344
- # managed in Google Domains. * Without further action, the domain does not renew
345
- # automatically. The new owner can set up billing in Google Domains to renew the
346
- # domain if needed.
346
+ # Exports a `Registration` resource, such that it is no longer managed by Cloud
347
+ # Domains. When an active domain is successfully exported, you can continue to
348
+ # use the domain in [Google Domains](https://domains.google/) until it expires.
349
+ # The calling user becomes the domain's sole owner in Google Domains, and
350
+ # permissions for the domain are subsequently managed there. The domain does not
351
+ # renew automatically unless the new owner sets up billing in Google Domains.
347
352
  # @param [String] name
348
353
  # Required. The name of the `Registration` to export, in the format `projects/*/
349
354
  # locations/*/registrations/*`.
@@ -414,13 +419,16 @@ module Google
414
419
  # REQUIRED: The resource for which the policy is being requested. See the
415
420
  # operation documentation for the appropriate value for this field.
416
421
  # @param [Fixnum] options_requested_policy_version
417
- # Optional. The policy format version to be returned. Valid values are 0, 1, and
418
- # 3. Requests specifying an invalid value will be rejected. Requests for
419
- # policies with any conditional bindings must specify version 3. Policies
420
- # without any conditional bindings may specify any valid value or leave the
421
- # field unset. To learn which resources support conditions in their IAM policies,
422
- # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
423
- # resource-policies).
422
+ # Optional. The maximum policy version that will be used to format the policy.
423
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
424
+ # rejected. Requests for policies with any conditional role bindings must
425
+ # specify version 3. Policies with no conditional role bindings may specify any
426
+ # valid value or leave the field unset. The policy in the response might use the
427
+ # policy version that you specified, or it might use a lower policy version. For
428
+ # example, if you specify version 3, but the policy has no conditional role
429
+ # bindings, the response uses version 1. To learn which resources support
430
+ # conditions in their IAM policies, see the [IAM documentation](https://cloud.
431
+ # google.com/iam/help/conditions/resource-policies).
424
432
  # @param [String] fields
425
433
  # Selector specifying which fields to include in a partial response.
426
434
  # @param [String] quota_user
@@ -512,7 +520,7 @@ module Google
512
520
  # @param [String] update_mask
513
521
  # Required. The field mask describing which fields to update as a comma-
514
522
  # separated list. For example, if only the labels are being updated, the `
515
- # update_mask` would be `"labels"`.
523
+ # update_mask` is `"labels"`.
516
524
  # @param [String] fields
517
525
  # Selector specifying which fields to include in a partial response.
518
526
  # @param [String] quota_user
@@ -689,6 +697,42 @@ module Google
689
697
  execute_or_queue_command(command, &block)
690
698
  end
691
699
 
700
+ # Gets parameters needed to transfer a domain name from another registrar to
701
+ # Cloud Domains. For domains managed by Google Domains, transferring to Cloud
702
+ # Domains is not supported. Use the returned values to call `TransferDomain`.
703
+ # @param [String] location
704
+ # Required. The location. Must be in the format `projects/*/locations/*`.
705
+ # @param [String] domain_name
706
+ # Required. The domain name. Unicode domain names must be expressed in Punycode
707
+ # format.
708
+ # @param [String] fields
709
+ # Selector specifying which fields to include in a partial response.
710
+ # @param [String] quota_user
711
+ # Available to use for quota purposes for server-side applications. Can be any
712
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
713
+ # @param [Google::Apis::RequestOptions] options
714
+ # Request-specific options
715
+ #
716
+ # @yield [result, err] Result & error if block supplied
717
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::RetrieveTransferParametersResponse] parsed result object
718
+ # @yieldparam err [StandardError] error object if request failed
719
+ #
720
+ # @return [Google::Apis::DomainsV1alpha2::RetrieveTransferParametersResponse]
721
+ #
722
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
723
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
724
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
725
+ def retrieve_project_location_registration_transfer_parameters(location, domain_name: nil, fields: nil, quota_user: nil, options: nil, &block)
726
+ command = make_simple_command(:get, 'v1alpha2/{+location}/registrations:retrieveTransferParameters', options)
727
+ command.response_representation = Google::Apis::DomainsV1alpha2::RetrieveTransferParametersResponse::Representation
728
+ command.response_class = Google::Apis::DomainsV1alpha2::RetrieveTransferParametersResponse
729
+ command.params['location'] = location unless location.nil?
730
+ command.query['domainName'] = domain_name unless domain_name.nil?
731
+ command.query['fields'] = fields unless fields.nil?
732
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
733
+ execute_or_queue_command(command, &block)
734
+ end
735
+
692
736
  # Searches for available domain names similar to the provided query.
693
737
  # Availability results from this method are approximate; call `
694
738
  # RetrieveRegisterParameters` on a domain before registering to confirm
@@ -798,6 +842,54 @@ module Google
798
842
  command.query['quotaUser'] = quota_user unless quota_user.nil?
799
843
  execute_or_queue_command(command, &block)
800
844
  end
845
+
846
+ # Transfers a domain name from another registrar to Cloud Domains. For domains
847
+ # managed by Google Domains, transferring to Cloud Domains is not supported.
848
+ # Before calling this method, go to the domain's current registrar to unlock the
849
+ # domain for transfer and retrieve the domain's transfer authorization code.
850
+ # Then call `RetrieveTransferParameters` to confirm that the domain is unlocked
851
+ # and to get values needed to build a call to this method. A successful call
852
+ # creates a `Registration` resource in state `TRANSFER_PENDING`. It can take
853
+ # several days to complete the transfer process. The registrant can often speed
854
+ # up this process by approving the transfer through the current registrar,
855
+ # either by clicking a link in an email from the registrar or by visiting the
856
+ # registrar's website. A few minutes after transfer approval, the resource
857
+ # transitions to state `ACTIVE`, indicating that the transfer was successful. If
858
+ # the transfer is rejected or the request expires without being approved, the
859
+ # resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can
860
+ # safely delete the resource and retry the transfer.
861
+ # @param [String] parent
862
+ # Required. The parent resource of the `Registration`. Must be in the format `
863
+ # projects/*/locations/*`.
864
+ # @param [Google::Apis::DomainsV1alpha2::TransferDomainRequest] transfer_domain_request_object
865
+ # @param [String] fields
866
+ # Selector specifying which fields to include in a partial response.
867
+ # @param [String] quota_user
868
+ # Available to use for quota purposes for server-side applications. Can be any
869
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
870
+ # @param [Google::Apis::RequestOptions] options
871
+ # Request-specific options
872
+ #
873
+ # @yield [result, err] Result & error if block supplied
874
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
875
+ # @yieldparam err [StandardError] error object if request failed
876
+ #
877
+ # @return [Google::Apis::DomainsV1alpha2::Operation]
878
+ #
879
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
880
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
881
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
882
+ def transfer_registration_domain(parent, transfer_domain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
883
+ command = make_simple_command(:post, 'v1alpha2/{+parent}/registrations:transfer', options)
884
+ command.request_representation = Google::Apis::DomainsV1alpha2::TransferDomainRequest::Representation
885
+ command.request_object = transfer_domain_request_object
886
+ command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
887
+ command.response_class = Google::Apis::DomainsV1alpha2::Operation
888
+ command.params['parent'] = parent unless parent.nil?
889
+ command.query['fields'] = fields unless fields.nil?
890
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
891
+ execute_or_queue_command(command, &block)
892
+ end
801
893
 
802
894
  protected
803
895
 
@@ -29,7 +29,7 @@ module Google
29
29
  # This is NOT the gem version.
30
30
  VERSION = 'V1alpha2'
31
31
 
32
- # See, edit, configure, and delete your Google Cloud Platform data
32
+ # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
33
33
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
34
34
  end
35
35
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-domains_v1alpha2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.0
4
+ version: 0.11.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-05 00:00:00.000000000 Z
11
+ date: 2021-11-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
57
57
  - Apache-2.0
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
- changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-domains_v1alpha2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-domains_v1alpha2/v0.7.0
62
- source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-domains_v1alpha2
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-domains_v1alpha2/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-domains_v1alpha2/v0.11.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-domains_v1alpha2
63
63
  post_install_message:
64
64
  rdoc_options: []
65
65
  require_paths: