google-api-client 0.42.0 → 0.42.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (158) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +70 -0
  3. data/generated/google/apis/admob_v1.rb +1 -1
  4. data/generated/google/apis/admob_v1/service.rb +1 -1
  5. data/generated/google/apis/appsmarket_v2.rb +1 -1
  6. data/generated/google/apis/billingbudgets_v1beta1.rb +1 -1
  7. data/generated/google/apis/billingbudgets_v1beta1/classes.rb +28 -13
  8. data/generated/google/apis/billingbudgets_v1beta1/representations.rb +1 -0
  9. data/generated/google/apis/blogger_v3.rb +1 -1
  10. data/generated/google/apis/chat_v1.rb +1 -1
  11. data/generated/google/apis/chat_v1/classes.rb +111 -0
  12. data/generated/google/apis/chat_v1/representations.rb +50 -0
  13. data/generated/google/apis/chat_v1/service.rb +32 -0
  14. data/generated/google/apis/classroom_v1.rb +1 -1
  15. data/generated/google/apis/classroom_v1/service.rb +5 -2
  16. data/generated/google/apis/cloudbuild_v1.rb +1 -1
  17. data/generated/google/apis/cloudbuild_v1/classes.rb +1 -1
  18. data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
  19. data/generated/google/apis/cloudidentity_v1beta1/classes.rb +25 -0
  20. data/generated/google/apis/cloudidentity_v1beta1/representations.rb +15 -0
  21. data/generated/google/apis/cloudscheduler_v1.rb +1 -1
  22. data/generated/google/apis/cloudscheduler_v1/classes.rb +5 -5
  23. data/generated/google/apis/cloudscheduler_v1beta1.rb +1 -1
  24. data/generated/google/apis/cloudscheduler_v1beta1/classes.rb +5 -5
  25. data/generated/google/apis/cloudtrace_v1.rb +1 -1
  26. data/generated/google/apis/cloudtrace_v1/classes.rb +2 -3
  27. data/generated/google/apis/cloudtrace_v1/service.rb +1 -7
  28. data/generated/google/apis/cloudtrace_v2.rb +1 -1
  29. data/generated/google/apis/cloudtrace_v2/classes.rb +6 -5
  30. data/generated/google/apis/cloudtrace_v2/service.rb +3 -6
  31. data/generated/google/apis/compute_beta.rb +1 -1
  32. data/generated/google/apis/compute_beta/classes.rb +279 -0
  33. data/generated/google/apis/compute_beta/representations.rb +90 -0
  34. data/generated/google/apis/compute_beta/service.rb +257 -0
  35. data/generated/google/apis/compute_v1.rb +1 -1
  36. data/generated/google/apis/compute_v1/classes.rb +279 -0
  37. data/generated/google/apis/compute_v1/representations.rb +90 -0
  38. data/generated/google/apis/compute_v1/service.rb +257 -0
  39. data/generated/google/apis/container_v1.rb +1 -1
  40. data/generated/google/apis/container_v1/classes.rb +9 -0
  41. data/generated/google/apis/container_v1/representations.rb +1 -0
  42. data/generated/google/apis/container_v1beta1.rb +1 -1
  43. data/generated/google/apis/container_v1beta1/classes.rb +15 -0
  44. data/generated/google/apis/container_v1beta1/representations.rb +2 -0
  45. data/generated/google/apis/content_v2.rb +1 -1
  46. data/generated/google/apis/content_v2/classes.rb +2 -2
  47. data/generated/google/apis/content_v2_1.rb +1 -1
  48. data/generated/google/apis/content_v2_1/classes.rb +4 -4
  49. data/generated/google/apis/customsearch_v1.rb +1 -1
  50. data/generated/google/apis/customsearch_v1/service.rb +12 -2
  51. data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
  52. data/generated/google/apis/datacatalog_v1beta1/classes.rb +3 -3
  53. data/generated/google/apis/dataflow_v1b3.rb +1 -1
  54. data/generated/google/apis/dataflow_v1b3/service.rb +2 -2
  55. data/generated/google/apis/dataproc_v1.rb +1 -1
  56. data/generated/google/apis/dataproc_v1/classes.rb +9 -9
  57. data/generated/google/apis/dataproc_v1beta2.rb +1 -1
  58. data/generated/google/apis/dataproc_v1beta2/classes.rb +9 -9
  59. data/generated/google/apis/datastore_v1.rb +1 -1
  60. data/generated/google/apis/datastore_v1/classes.rb +1 -1
  61. data/generated/google/apis/displayvideo_v1.rb +1 -1
  62. data/generated/google/apis/displayvideo_v1/service.rb +2 -1
  63. data/generated/google/apis/dlp_v2.rb +1 -1
  64. data/generated/google/apis/dlp_v2/classes.rb +5 -2
  65. data/generated/google/apis/dns_v1.rb +1 -1
  66. data/generated/google/apis/dns_v1beta2.rb +1 -1
  67. data/generated/google/apis/dns_v2beta1.rb +4 -4
  68. data/generated/google/apis/dns_v2beta1/classes.rb +313 -162
  69. data/generated/google/apis/dns_v2beta1/service.rb +247 -180
  70. data/generated/google/apis/drive_v2.rb +1 -1
  71. data/generated/google/apis/drive_v2/classes.rb +66 -2
  72. data/generated/google/apis/drive_v2/representations.rb +22 -0
  73. data/generated/google/apis/drive_v2/service.rb +23 -10
  74. data/generated/google/apis/drive_v3.rb +1 -1
  75. data/generated/google/apis/drive_v3/classes.rb +65 -2
  76. data/generated/google/apis/drive_v3/representations.rb +22 -0
  77. data/generated/google/apis/drive_v3/service.rb +8 -5
  78. data/generated/google/apis/firestore_v1.rb +1 -1
  79. data/generated/google/apis/firestore_v1/classes.rb +152 -0
  80. data/generated/google/apis/firestore_v1/representations.rb +63 -0
  81. data/generated/google/apis/firestore_v1/service.rb +78 -0
  82. data/generated/google/apis/firestore_v1beta1.rb +1 -1
  83. data/generated/google/apis/firestore_v1beta1/classes.rb +152 -0
  84. data/generated/google/apis/firestore_v1beta1/representations.rb +63 -0
  85. data/generated/google/apis/firestore_v1beta1/service.rb +78 -0
  86. data/generated/google/apis/gmail_v1.rb +1 -1
  87. data/generated/google/apis/gmail_v1/classes.rb +53 -53
  88. data/generated/google/apis/gmail_v1/service.rb +72 -72
  89. data/generated/google/apis/healthcare_v1.rb +1 -1
  90. data/generated/google/apis/healthcare_v1/service.rb +48 -1
  91. data/generated/google/apis/healthcare_v1beta1.rb +1 -1
  92. data/generated/google/apis/healthcare_v1beta1/service.rb +60 -1
  93. data/generated/google/apis/iam_v1.rb +1 -1
  94. data/generated/google/apis/iam_v1/classes.rb +22 -3
  95. data/generated/google/apis/iam_v1/service.rb +18 -6
  96. data/generated/google/apis/memcache_v1beta2.rb +1 -1
  97. data/generated/google/apis/memcache_v1beta2/classes.rb +1 -1
  98. data/generated/google/apis/ml_v1.rb +1 -1
  99. data/generated/google/apis/ml_v1/classes.rb +17 -11
  100. data/generated/google/apis/monitoring_v3.rb +1 -1
  101. data/generated/google/apis/monitoring_v3/classes.rb +54 -30
  102. data/generated/google/apis/networkmanagement_v1.rb +1 -1
  103. data/generated/google/apis/networkmanagement_v1/classes.rb +6 -6
  104. data/generated/google/apis/networkmanagement_v1beta1.rb +1 -1
  105. data/generated/google/apis/networkmanagement_v1beta1/classes.rb +6 -6
  106. data/generated/google/apis/osconfig_v1.rb +1 -1
  107. data/generated/google/apis/osconfig_v1/classes.rb +2 -2
  108. data/generated/google/apis/osconfig_v1beta.rb +1 -1
  109. data/generated/google/apis/osconfig_v1beta/classes.rb +2 -2
  110. data/generated/google/apis/realtimebidding_v1.rb +1 -1
  111. data/generated/google/apis/recommendationengine_v1beta1.rb +36 -0
  112. data/generated/google/apis/recommendationengine_v1beta1/classes.rb +2015 -0
  113. data/generated/google/apis/recommendationengine_v1beta1/representations.rb +848 -0
  114. data/generated/google/apis/recommendationengine_v1beta1/service.rb +990 -0
  115. data/generated/google/apis/remotebuildexecution_v1.rb +1 -1
  116. data/generated/google/apis/remotebuildexecution_v1alpha.rb +1 -1
  117. data/generated/google/apis/remotebuildexecution_v2.rb +1 -1
  118. data/generated/google/apis/reseller_v1.rb +4 -3
  119. data/generated/google/apis/reseller_v1/classes.rb +219 -160
  120. data/generated/google/apis/reseller_v1/service.rb +247 -252
  121. data/generated/google/apis/run_v1.rb +2 -2
  122. data/generated/google/apis/run_v1/classes.rb +6 -1
  123. data/generated/google/apis/run_v1/service.rb +1 -1
  124. data/generated/google/apis/run_v1alpha1.rb +2 -2
  125. data/generated/google/apis/run_v1alpha1/service.rb +1 -1
  126. data/generated/google/apis/run_v1beta1.rb +2 -2
  127. data/generated/google/apis/run_v1beta1/service.rb +1 -1
  128. data/generated/google/apis/searchconsole_v1.rb +4 -3
  129. data/generated/google/apis/searchconsole_v1/service.rb +3 -2
  130. data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
  131. data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +2 -2
  132. data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
  133. data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +2 -2
  134. data/generated/google/apis/servicecontrol_v1.rb +1 -1
  135. data/generated/google/apis/servicecontrol_v1/classes.rb +6 -6
  136. data/generated/google/apis/servicemanagement_v1.rb +1 -1
  137. data/generated/google/apis/servicemanagement_v1/classes.rb +2 -2
  138. data/generated/google/apis/servicenetworking_v1.rb +1 -1
  139. data/generated/google/apis/servicenetworking_v1/classes.rb +2 -2
  140. data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
  141. data/generated/google/apis/servicenetworking_v1beta/classes.rb +2 -2
  142. data/generated/google/apis/serviceusage_v1.rb +1 -1
  143. data/generated/google/apis/serviceusage_v1/classes.rb +2 -2
  144. data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
  145. data/generated/google/apis/serviceusage_v1beta1/classes.rb +2 -2
  146. data/generated/google/apis/sheets_v4.rb +1 -1
  147. data/generated/google/apis/sheets_v4/classes.rb +28 -28
  148. data/generated/google/apis/vision_v1.rb +1 -1
  149. data/generated/google/apis/vision_v1/classes.rb +2 -0
  150. data/generated/google/apis/vision_v1p1beta1.rb +1 -1
  151. data/generated/google/apis/vision_v1p1beta1/classes.rb +2 -0
  152. data/generated/google/apis/vision_v1p2beta1.rb +1 -1
  153. data/generated/google/apis/vision_v1p2beta1/classes.rb +2 -0
  154. data/generated/google/apis/youtube_v3.rb +1 -1
  155. data/generated/google/apis/youtube_v3/classes.rb +2 -2
  156. data/generated/google/apis/youtube_v3/service.rb +1 -0
  157. data/lib/google/apis/version.rb +1 -1
  158. metadata +7 -3
@@ -25,7 +25,7 @@ module Google
25
25
  # @see https://cloud.google.com/remote-build-execution/docs/
26
26
  module RemotebuildexecutionV1
27
27
  VERSION = 'V1'
28
- REVISION = '20200623'
28
+ REVISION = '20200714'
29
29
 
30
30
  # View and manage your data across Google Cloud Platform services
31
31
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -25,7 +25,7 @@ module Google
25
25
  # @see https://cloud.google.com/remote-build-execution/docs/
26
26
  module RemotebuildexecutionV1alpha
27
27
  VERSION = 'V1alpha'
28
- REVISION = '20200623'
28
+ REVISION = '20200714'
29
29
 
30
30
  # View and manage your data across Google Cloud Platform services
31
31
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -25,7 +25,7 @@ module Google
25
25
  # @see https://cloud.google.com/remote-build-execution/docs/
26
26
  module RemotebuildexecutionV2
27
27
  VERSION = 'V2'
28
- REVISION = '20200623'
28
+ REVISION = '20200714'
29
29
 
30
30
  # View and manage your data across Google Cloud Platform services
31
31
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -18,14 +18,15 @@ require 'google/apis/reseller_v1/representations.rb'
18
18
 
19
19
  module Google
20
20
  module Apis
21
- # Enterprise Apps Reseller API
21
+ # Google Apps Reseller API
22
22
  #
23
- # Creates and manages your customers and their subscriptions.
23
+ # Perform common functions that are available on the Google Apps Reseller
24
+ # Console at scale like placing orders and viewing customer information
24
25
  #
25
26
  # @see https://developers.google.com/google-apps/reseller/
26
27
  module ResellerV1
27
28
  VERSION = 'V1'
28
- REVISION = '20191008'
29
+ REVISION = '20200627'
29
30
 
30
31
  # Manage users on your domain
31
32
  AUTH_APPS_ORDER = 'https://www.googleapis.com/auth/apps.order'
@@ -27,7 +27,8 @@ module Google
27
27
  include Google::Apis::Core::Hashable
28
28
 
29
29
  # A customer's physical address. An address can be composed of one to three
30
- # lines. The addressline2 and addressLine3 are optional.
30
+ # lines. The <code>addressline2</code> and <code>addressLine3</code> are
31
+ # optional.
31
32
  # Corresponds to the JSON property `addressLine1`
32
33
  # @return [String]
33
34
  attr_accessor :address_line1
@@ -47,19 +48,23 @@ module Google
47
48
  # @return [String]
48
49
  attr_accessor :contact_name
49
50
 
50
- # For countryCode information, see the ISO 3166 country code elements. Verify
51
- # that country is approved for resale of Google products. This property is
52
- # required when creating a new customer.
51
+ # For <code>countryCode</code> information, see the <a
52
+ # href="http://www.iso.org/iso/country_codes.htm">ISO 3166 country code
53
+ # elements</a>. Verify that country is <a
54
+ # href="https://www.cloudconnect.goog/docs/DOC-29141">approved</a> for resale
55
+ # of Google products. This property is required when creating a new customer.
53
56
  # Corresponds to the JSON property `countryCode`
54
57
  # @return [String]
55
58
  attr_accessor :country_code
56
59
 
57
- # Identifies the resource as a customer address. Value: customers#address
60
+ # Identifies the resource as a customer address. Value:
61
+ # <code>customers#address</code>
58
62
  # Corresponds to the JSON property `kind`
59
63
  # @return [String]
60
64
  attr_accessor :kind
61
65
 
62
- # An example of a locality value is the city of San Francisco.
66
+ # An example of a <code>locality</code> value is the city of <code>San
67
+ # Francisco</code>.
63
68
  # Corresponds to the JSON property `locality`
64
69
  # @return [String]
65
70
  attr_accessor :locality
@@ -69,13 +74,14 @@ module Google
69
74
  # @return [String]
70
75
  attr_accessor :organization_name
71
76
 
72
- # A postalCode example is a postal zip code such as 94043. This property is
73
- # required when creating a new customer.
77
+ # A <code>postalCode</code> example is a postal zip code such as
78
+ # <code>94043</code>. This property is required when creating a new customer.
74
79
  # Corresponds to the JSON property `postalCode`
75
80
  # @return [String]
76
81
  attr_accessor :postal_code
77
82
 
78
- # An example of a region value is CA for the state of California.
83
+ # An example of a <code>region</code> value is <code>CA</code> for the state
84
+ # of California.
79
85
  # Corresponds to the JSON property `region`
80
86
  # @return [String]
81
87
  attr_accessor :region
@@ -103,41 +109,44 @@ module Google
103
109
  class ChangePlanRequest
104
110
  include Google::Apis::Core::Hashable
105
111
 
106
- # Google-issued code (100 char max) for discounted pricing on subscription plans.
107
- # Deal code must be included in changePlan request in order to receive
108
- # discounted rate. This property is optional. If a deal code has already been
109
- # added to a subscription, this property may be left empty and the existing
110
- # discounted rate will still apply (if not empty, only provide the deal code
111
- # that is already present on the subscription). If a deal code has never been
112
- # added to a subscription and this property is left blank, regular pricing will
113
- # apply.
112
+ # Google-issued code (100 char max) for discounted pricing on subscription
113
+ # plans. Deal code must be included in <code>changePlan</code> request in
114
+ # order to receive discounted rate. This property is optional. If a deal code
115
+ # has already been added to a subscription, this property may be left empty
116
+ # and the existing discounted rate will still apply (if not empty, only
117
+ # provide the deal code that is already present on the subscription). If a
118
+ # deal code has never been added to a subscription and this property is left
119
+ # blank, regular pricing will apply.
114
120
  # Corresponds to the JSON property `dealCode`
115
121
  # @return [String]
116
122
  attr_accessor :deal_code
117
123
 
118
124
  # Identifies the resource as a subscription change plan request. Value:
119
- # subscriptions#changePlanRequest
125
+ # <code>subscriptions#changePlanRequest</code>
120
126
  # Corresponds to the JSON property `kind`
121
127
  # @return [String]
122
128
  attr_accessor :kind
123
129
 
124
- # The planName property is required. This is the name of the subscription's
125
- # payment plan. For more information about the Google payment plans, see API
126
- # concepts.
127
- # Possible values are:
128
- # - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments
129
- # Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
130
- # - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments
131
- # - FLEXIBLE - The flexible plan
132
- # - TRIAL - The 30-day free trial plan
130
+ # The <code>planName</code> property is required. This is the name of the
131
+ # subscription's payment plan. For more information about the Google payment
132
+ # plans, see <a href="/admin-sdk/reseller/v1/how-tos/concepts.html">API
133
+ # concepts</a>. <br><br>Possible values are: <ul> <li>
134
+ # <code>ANNUAL_MONTHLY_PAY</code> - The annual commitment plan with monthly
135
+ # payments <aside class="caution"> <strong>Caution:
136
+ # </strong><code>ANNUAL_MONTHLY_PAY</code> is returned as <code>ANNUAL</code>
137
+ # in all API responses.</aside> </li> <li> <code>ANNUAL_YEARLY_PAY</code> -
138
+ # The annual commitment plan with yearly payments </li> <li>
139
+ # <code>FLEXIBLE</code> - The flexible plan </li> <li> <code>TRIAL</code> -
140
+ # The 30-day free trial plan </li> </ul>
133
141
  # Corresponds to the JSON property `planName`
134
142
  # @return [String]
135
143
  attr_accessor :plan_name
136
144
 
137
145
  # This is an optional property. This purchase order (PO) information is for
138
- # resellers to use for their company tracking usage. If a purchaseOrderId value
139
- # is given it appears in the API responses and shows up in the invoice. The
140
- # property accepts up to 80 plain text characters.
146
+ # resellers to use for their company tracking usage. If a
147
+ # <code>purchaseOrderId</code> value is given it appears in the API responses
148
+ # and shows up in the invoice. The property accepts up to 80 plain text
149
+ # characters.
141
150
  # Corresponds to the JSON property `purchaseOrderId`
142
151
  # @return [String]
143
152
  attr_accessor :purchase_order_id
@@ -165,17 +174,18 @@ module Google
165
174
  class Customer
166
175
  include Google::Apis::Core::Hashable
167
176
 
168
- # Like the "Customer email" in the reseller tools, this email is the secondary
169
- # contact used if something happens to the customer's service such as service
170
- # outage or a security issue. This property is required when creating a new
171
- # customer and should not use the same domain as customerDomain.
177
+ # Like the &quot;Customer email&quot; in the reseller tools, this email is
178
+ # the secondary contact used if something happens to the
179
+ # customer's service such as service outage or a security issue. This
180
+ # property is required when creating a new customer and should not use the
181
+ # same domain as <code>customerDomain</code>.
172
182
  # Corresponds to the JSON property `alternateEmail`
173
183
  # @return [String]
174
184
  attr_accessor :alternate_email
175
185
 
176
- # The customer's primary domain name string. customerDomain is required when
177
- # creating a new customer. Do not include the www prefix in the domain when
178
- # adding a customer.
186
+ # The customer's primary domain name string. <code>customerDomain</code> is
187
+ # required when creating a new customer. Do not include the <code>www</code>
188
+ # prefix in the domain when adding a customer.
179
189
  # Corresponds to the JSON property `customerDomain`
180
190
  # @return [String]
181
191
  attr_accessor :customer_domain
@@ -186,21 +196,25 @@ module Google
186
196
  attr_accessor :customer_domain_verified
187
197
  alias_method :customer_domain_verified?, :customer_domain_verified
188
198
 
189
- # This property will always be returned in a response as the unique identifier
190
- # generated by Google. In a request, this property can be either the primary
191
- # domain or the unique identifier generated by Google.
199
+ # This property will always be returned in a response as the unique
200
+ # identifier generated by Google. In a request, this property can be either
201
+ # the primary domain or the unique identifier generated by Google.
192
202
  # Corresponds to the JSON property `customerId`
193
203
  # @return [String]
194
204
  attr_accessor :customer_id
195
205
 
196
- # Identifies the resource as a customer. Value: reseller#customer
206
+ # Identifies the resource as a customer. Value:
207
+ # <code>reseller#customer</code>
197
208
  # Corresponds to the JSON property `kind`
198
209
  # @return [String]
199
210
  attr_accessor :kind
200
211
 
201
212
  # Customer contact phone number. Must start with "+" followed by the country
202
213
  # code. The rest of the number can be contiguous numbers or respect the phone
203
- # local format conventions, but it must be a real phone number and not, for
214
+ # <a
215
+ # href="http://wikipedia.org/wiki/
216
+ # Local_conventions_for_writing_telephone_numbers">local
217
+ # format conventions</a>, but it must be a real phone number and not, for
204
218
  # example, "123". This field is silently ignored if invalid.
205
219
  # Corresponds to the JSON property `phoneNumber`
206
220
  # @return [String]
@@ -211,9 +225,9 @@ module Google
211
225
  # @return [Google::Apis::ResellerV1::Address]
212
226
  attr_accessor :postal_address
213
227
 
214
- # URL to customer's Admin console dashboard. The read-only URL is generated by
215
- # the API service. This is used if your client application requires the customer
216
- # to complete a task in the Admin console.
228
+ # URL to customer&#39;s Admin console dashboard. The read-only URL is
229
+ # generated by the API service. This is used if your client application
230
+ # requires the customer to complete a task in the Admin console.
217
231
  # Corresponds to the JSON property `resourceUiUrl`
218
232
  # @return [String]
219
233
  attr_accessor :resource_ui_url
@@ -240,14 +254,17 @@ module Google
240
254
  include Google::Apis::Core::Hashable
241
255
 
242
256
  # Identifies the resource as a subscription renewal setting. Value:
243
- # subscriptions#renewalSettings
257
+ # <code>subscriptions#renewalSettings</code>
244
258
  # Corresponds to the JSON property `kind`
245
259
  # @return [String]
246
260
  attr_accessor :kind
247
261
 
248
- # Renewal settings for the annual commitment plan. For more detailed information,
249
- # see renewal options in the administrator help center. When renewing a
250
- # subscription, the renewalType is a required property.
262
+ # Renewal settings for the annual commitment plan. For more detailed
263
+ # information, see renewal options in the <a
264
+ # href="//support.google.com/a/bin/answer.py?topic=1247359&amp;ctx=topic&amp;
265
+ # answer=2500693">administrator
266
+ # help center</a>. When renewing a subscription, the <code>renewalType</code>
267
+ # is a required property.
251
268
  # Corresponds to the JSON property `renewalType`
252
269
  # @return [String]
253
270
  attr_accessor :renewal_type
@@ -311,37 +328,42 @@ module Google
311
328
  class Seats
312
329
  include Google::Apis::Core::Hashable
313
330
 
314
- # Identifies the resource as a subscription seat setting. Value: subscriptions#
315
- # seats
331
+ # Identifies the resource as a subscription seat setting. Value:
332
+ # <code>subscriptions#seats</code>
316
333
  # Corresponds to the JSON property `kind`
317
334
  # @return [String]
318
335
  attr_accessor :kind
319
336
 
320
337
  # Read-only field containing the current number of users that are assigned a
321
- # license for the product defined in skuId. This field's value is equivalent to
322
- # the numerical count of users returned by the Enterprise License Manager API
323
- # method: listForProductAndSku
338
+ # license for the product defined in <code>skuId</code>. This
339
+ # field's value is equivalent to the numerical count of users returned by the
340
+ # Enterprise License Manager API method: <code><a
341
+ # href="//developers.google.com/admin-sdk/licensing/v1/reference/
342
+ # licenseAssignments/listForProductAndSku">listForProductAndSku</a></code>
324
343
  # Corresponds to the JSON property `licensedNumberOfSeats`
325
344
  # @return [Fixnum]
326
345
  attr_accessor :licensed_number_of_seats
327
346
 
328
- # This is a required property and is exclusive to subscriptions with FLEXIBLE or
329
- # TRIAL plans. This property sets the maximum number of licensed users allowed
330
- # on a subscription. This quantity can be increased up to the maximum limit
331
- # defined in the reseller's contract. The minimum quantity is the current number
332
- # of users in the customer account. Note: G Suite subscriptions automatically
333
- # assign a license to every user.
347
+ # This is a required property and is exclusive to subscriptions with
348
+ # <code>FLEXIBLE</code> or <code>TRIAL</code> plans. This property sets the
349
+ # maximum number of licensed users allowed on a subscription. This quantity
350
+ # can be increased up to the maximum limit defined in the
351
+ # reseller's contract. The minimum quantity is the current number of users in
352
+ # the customer account. <aside class="note"><strong>Note: </strong>G Suite
353
+ # subscriptions automatically assign a license to every user.</aside>
334
354
  # Corresponds to the JSON property `maximumNumberOfSeats`
335
355
  # @return [Fixnum]
336
356
  attr_accessor :maximum_number_of_seats
337
357
 
338
358
  # This is a required property and is exclusive to subscriptions with
339
- # ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum
340
- # number of licenses assignable to users on a subscription. The reseller can add
341
- # more licenses, but once set, the numberOfSeats cannot be reduced until renewal.
342
- # The reseller is invoiced based on the numberOfSeats value regardless of how
343
- # many of these user licenses are assigned. Note: G Suite subscriptions
344
- # automatically assign a license to every user.
359
+ # <code>ANNUAL_MONTHLY_PAY</code> and <code>ANNUAL_YEARLY_PAY</code> plans.
360
+ # This property sets the maximum number of licenses assignable to users on a
361
+ # subscription. The reseller can add more licenses, but once set, the
362
+ # <code>numberOfSeats</code> cannot be reduced until renewal. The reseller is
363
+ # invoiced based on the <code>numberOfSeats</code> value regardless of how
364
+ # many of these user licenses are assigned. <aside class="note"><strong>Note:
365
+ # </strong>G Suite subscriptions automatically assign a license to every
366
+ # user.</aside>
345
367
  # Corresponds to the JSON property `numberOfSeats`
346
368
  # @return [Fixnum]
347
369
  attr_accessor :number_of_seats
@@ -368,8 +390,9 @@ module Google
368
390
  # @return [String]
369
391
  attr_accessor :billing_method
370
392
 
371
- # The creationTime property is the date when subscription was created. It is in
372
- # milliseconds using the Epoch format. See an example Epoch converter.
393
+ # The <code>creationTime</code> property is the date when subscription was
394
+ # created. It is in milliseconds using the Epoch format. See an example <a
395
+ # href="http://www.epochconverter.com/">Epoch converter</a>.
373
396
  # Corresponds to the JSON property `creationTime`
374
397
  # @return [Fixnum]
375
398
  attr_accessor :creation_time
@@ -379,36 +402,41 @@ module Google
379
402
  # @return [String]
380
403
  attr_accessor :customer_domain
381
404
 
382
- # This property will always be returned in a response as the unique identifier
383
- # generated by Google. In a request, this property can be either the primary
384
- # domain or the unique identifier generated by Google.
405
+ # This property will always be returned in a response as the unique
406
+ # identifier generated by Google. In a request, this property can be either
407
+ # the primary domain or the unique identifier generated by Google.
385
408
  # Corresponds to the JSON property `customerId`
386
409
  # @return [String]
387
410
  attr_accessor :customer_id
388
411
 
389
- # Google-issued code (100 char max) for discounted pricing on subscription plans.
390
- # Deal code must be included in insert requests in order to receive discounted
391
- # rate. This property is optional, regular pricing applies if left empty.
412
+ # Google-issued code (100 char max) for discounted pricing on subscription
413
+ # plans. Deal code must be included in <code>insert</code> requests in order
414
+ # to receive discounted rate. This property is optional, regular pricing
415
+ # applies if left empty.
392
416
  # Corresponds to the JSON property `dealCode`
393
417
  # @return [String]
394
418
  attr_accessor :deal_code
395
419
 
396
- # Identifies the resource as a Subscription. Value: reseller#subscription
420
+ # Identifies the resource as a Subscription. Value:
421
+ # <code>reseller#subscription</code>
397
422
  # Corresponds to the JSON property `kind`
398
423
  # @return [String]
399
424
  attr_accessor :kind
400
425
 
401
- # The plan property is required. In this version of the API, the G Suite plans
402
- # are the flexible plan, annual commitment plan, and the 30-day free trial plan.
403
- # For more information about the API"s payment plans, see the API concepts.
426
+ # The <code>plan</code> property is required. In this version of the API, the
427
+ # G Suite plans are the flexible plan, annual commitment plan, and the 30-day
428
+ # free trial plan. For more information about the API&quot;s payment plans,
429
+ # see the <a href="/admin-sdk/reseller/v1/how-tos/concepts#plans">API
430
+ # concepts</a>.
404
431
  # Corresponds to the JSON property `plan`
405
432
  # @return [Google::Apis::ResellerV1::Subscription::Plan]
406
433
  attr_accessor :plan
407
434
 
408
435
  # This is an optional property. This purchase order (PO) information is for
409
- # resellers to use for their company tracking usage. If a purchaseOrderId value
410
- # is given it appears in the API responses and shows up in the invoice. The
411
- # property accepts up to 80 plain text characters.
436
+ # resellers to use for their company tracking usage. If a
437
+ # <code>purchaseOrderId</code> value is given it appears in the API responses
438
+ # and shows up in the invoice. The property accepts up to 80 plain text
439
+ # characters.
412
440
  # Corresponds to the JSON property `purchaseOrderId`
413
441
  # @return [String]
414
442
  attr_accessor :purchase_order_id
@@ -418,10 +446,10 @@ module Google
418
446
  # @return [Google::Apis::ResellerV1::RenewalSettings]
419
447
  attr_accessor :renewal_settings
420
448
 
421
- # URL to customer's Subscriptions page in the Admin console. The read-only URL
422
- # is generated by the API service. This is used if your client application
423
- # requires the customer to complete a task using the Subscriptions page in the
424
- # Admin console.
449
+ # URL to customer&#39;s Subscriptions page in the Admin console. The
450
+ # read-only URL is generated by the API service. This is used if your client
451
+ # application requires the customer to complete a task using the
452
+ # Subscriptions page in the Admin console.
425
453
  # Corresponds to the JSON property `resourceUiUrl`
426
454
  # @return [String]
427
455
  attr_accessor :resource_ui_url
@@ -431,17 +459,20 @@ module Google
431
459
  # @return [Google::Apis::ResellerV1::Seats]
432
460
  attr_accessor :seats
433
461
 
434
- # A required property. The skuId is a unique system identifier for a product's
435
- # SKU assigned to a customer in the subscription. For products and SKUs
436
- # available in this version of the API, see Product and SKU IDs.
462
+ # A required property. The <code>skuId</code> is a unique system identifier
463
+ # for a product&#39;s SKU assigned to a customer in the subscription. For
464
+ # products and SKUs available in this version of the API, see <a
465
+ # href="/admin-sdk/reseller/v1/how-tos/products.html"> Product and SKU
466
+ # IDs</a>.
437
467
  # Corresponds to the JSON property `skuId`
438
468
  # @return [String]
439
469
  attr_accessor :sku_id
440
470
 
441
- # Read-only external display name for a product's SKU assigned to a customer in
442
- # the subscription. SKU names are subject to change at Google's discretion. For
443
- # products and SKUs available in this version of the API, see Product and SKU
444
- # IDs.
471
+ # Read-only external display name for a product&#39;s SKU assigned to a
472
+ # customer in the subscription. SKU names are subject to change at
473
+ # Google&#39;s discretion. For products and SKUs available in this version of
474
+ # the API, see <a href="/admin-sdk/reseller/v1/how-tos/products.html">
475
+ # Product and SKU IDs</a>.
445
476
  # Corresponds to the JSON property `skuName`
446
477
  # @return [String]
447
478
  attr_accessor :sku_name
@@ -451,40 +482,48 @@ module Google
451
482
  # @return [String]
452
483
  attr_accessor :status
453
484
 
454
- # The subscriptionId is the subscription identifier and is unique for each
455
- # customer. This is a required property. Since a subscriptionId changes when a
456
- # subscription is updated, we recommend not using this ID as a key for
457
- # persistent data. Use the subscriptionId as described in retrieve all reseller
458
- # subscriptions.
485
+ # The <code>subscriptionId</code> is the subscription identifier and is
486
+ # unique for each customer. This is a required property. Since a
487
+ # <code>subscriptionId</code> changes when a subscription is updated, we
488
+ # recommend not using this ID as a key for persistent data. Use the
489
+ # <code>subscriptionId</code> as described in <a
490
+ # href="/admin-sdk/reseller/v1/how-tos/manage_subscriptions#
491
+ # get_all_subscriptions">retrieve
492
+ # all reseller subscriptions</a>.
459
493
  # Corresponds to the JSON property `subscriptionId`
460
494
  # @return [String]
461
495
  attr_accessor :subscription_id
462
496
 
463
- # Read-only field containing an enumerable of all the current suspension reasons
464
- # for a subscription. It is possible for a subscription to have many concurrent,
465
- # overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all
466
- # pending suspensions are removed.
467
- # Possible options include:
468
- # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G
469
- # Suite Resold Terms of Services.
470
- # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service
471
- # was cancelled at the end of their term.
472
- # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
473
- # - TRIAL_ENDED - The customer's trial expired without a plan selected.
474
- # - OTHER - The customer is suspended for an internal Google reason (e.g. abuse
475
- # or otherwise).
497
+ # Read-only field containing an enumerable of all the current suspension
498
+ # reasons for a subscription. It is possible for a subscription to have many
499
+ # concurrent, overlapping suspension reasons. A
500
+ # subscription's <code>STATUS</code> is <code>SUSPENDED</code> until all
501
+ # pending suspensions are removed. <br/><br/>Possible options include: <ul>
502
+ # <li> <code>PENDING_TOS_ACCEPTANCE</code> - The customer has not logged in
503
+ # and accepted the G Suite Resold Terms of Services. </li> <li>
504
+ # <code>RENEWAL_WITH_TYPE_CANCEL</code> - The customer's commitment ended and
505
+ # their service was cancelled at the end of their term.
506
+ # </li> <li> <code>RESELLER_INITIATED</code> - A manual suspension invoked by
507
+ # a Reseller. </li> <li> <code>TRIAL_ENDED</code> - The
508
+ # customer's trial expired without a plan selected. </li> <li>
509
+ # <code>OTHER</code> - The customer is suspended for an internal Google
510
+ # reason (e.g. abuse or otherwise). </li> </ul>
476
511
  # Corresponds to the JSON property `suspensionReasons`
477
512
  # @return [Array<String>]
478
513
  attr_accessor :suspension_reasons
479
514
 
480
515
  # Read-only transfer related information for the subscription. For more
481
- # information, see retrieve transferable subscriptions for a customer.
516
+ # information, see <a
517
+ # href="/admin-sdk/reseller/v1/how-tos/manage_subscriptions#
518
+ # get_transferable_subscriptions">retrieve
519
+ # transferable subscriptions for a customer</a>.
482
520
  # Corresponds to the JSON property `transferInfo`
483
521
  # @return [Google::Apis::ResellerV1::Subscription::TransferInfo]
484
522
  attr_accessor :transfer_info
485
523
 
486
524
  # The G Suite annual commitment and flexible payment plans can be in a 30-day
487
- # free trial. For more information, see the API concepts.
525
+ # free trial. For more information, see the <a
526
+ # href="/admin-sdk/reseller/v1/how-tos/concepts#plans">API concepts</a>.
488
527
  # Corresponds to the JSON property `trialSettings`
489
528
  # @return [Google::Apis::ResellerV1::Subscription::TrialSettings]
490
529
  attr_accessor :trial_settings
@@ -515,42 +554,52 @@ module Google
515
554
  @trial_settings = args[:trial_settings] if args.key?(:trial_settings)
516
555
  end
517
556
 
518
- # The plan property is required. In this version of the API, the G Suite plans
519
- # are the flexible plan, annual commitment plan, and the 30-day free trial plan.
520
- # For more information about the API"s payment plans, see the API concepts.
557
+ # The <code>plan</code> property is required. In this version of the API, the
558
+ # G Suite plans are the flexible plan, annual commitment plan, and the 30-day
559
+ # free trial plan. For more information about the API&quot;s payment plans,
560
+ # see the <a href="/admin-sdk/reseller/v1/how-tos/concepts#plans">API
561
+ # concepts</a>.
521
562
  class Plan
522
563
  include Google::Apis::Core::Hashable
523
564
 
524
- # In this version of the API, annual commitment plan's interval is one year.
525
- # Note: When billingMethod value is OFFLINE, the subscription property object
526
- # plan.commitmentInterval is omitted in all API responses.
565
+ # In this version of the API, annual commitment plan's interval is one
566
+ # year. <aside class="caution"> <strong>Note: </strong>When
567
+ # <code>billingMethod</code> value is <code>OFFLINE</code>, the
568
+ # subscription property object <code>plan.commitmentInterval</code> is
569
+ # omitted in all API responses. </aside>
527
570
  # Corresponds to the JSON property `commitmentInterval`
528
571
  # @return [Google::Apis::ResellerV1::Subscription::Plan::CommitmentInterval]
529
572
  attr_accessor :commitment_interval
530
573
 
531
- # The isCommitmentPlan property's boolean value identifies the plan as an annual
532
- # commitment plan:
533
- # - true — The subscription's plan is an annual commitment plan.
534
- # - false The plan is not an annual commitment plan.
574
+ # The <code>isCommitmentPlan</code> property&#39;s boolean value identifies
575
+ # the plan as an annual commitment plan:<ul><li><code>true</code> &mdash;
576
+ # The subscription&#39;s plan is an annual commitment
577
+ # plan.</li><li><code>false</code> &mdash; The plan is not an annual
578
+ # commitment plan.</li></ul>
535
579
  # Corresponds to the JSON property `isCommitmentPlan`
536
580
  # @return [Boolean]
537
581
  attr_accessor :is_commitment_plan
538
582
  alias_method :is_commitment_plan?, :is_commitment_plan
539
583
 
540
- # The planName property is required. This is the name of the subscription's plan.
541
- # For more information about the Google payment plans, see the API concepts.
542
- # Possible values are:
543
- # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments.
544
- # Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
545
- # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
546
- # - FLEXIBLE — The flexible plan
547
- # - TRIAL The 30-day free trial plan. A subscription in trial will be
548
- # suspended after the 30th free day if no payment plan is assigned. Calling
549
- # changePlan will assign a payment plan to a trial but will not activate the
550
- # plan. A trial will automatically begin its assigned payment plan after its
551
- # 30th free day or immediately after calling startPaidService.
552
- # - FREE The free plan is exclusive to the Cloud Identity SKU and does not
553
- # incur any billing.
584
+ # The <code>planName</code> property is required. This is the name of the
585
+ # subscription&#39;s plan. For more information about the Google payment
586
+ # plans, see the <a
587
+ # href="/admin-sdk/reseller/v1/how-tos/concepts#plans">API concepts</a>.
588
+ # <br/><br/>Possible values are: <ul> <li> <code>ANNUAL_MONTHLY_PAY</code>
589
+ # &mdash; The annual commitment plan with monthly payments. <aside
590
+ # class="caution"> <strong>Caution:
591
+ # </strong><code>ANNUAL_MONTHLY_PAY</code> is returned as
592
+ # <code>ANNUAL</code> in all API responses.</aside> </li> <li>
593
+ # <code>ANNUAL_YEARLY_PAY</code> &mdash; The annual commitment plan with
594
+ # yearly payments </li> <li> <code>FLEXIBLE</code> &mdash; The flexible
595
+ # plan </li> <li> <code>TRIAL</code> &mdash; The 30-day free trial plan. A
596
+ # subscription in trial will be suspended after the 30th free day if no
597
+ # payment plan is assigned. Calling <code>changePlan</code> will assign a
598
+ # payment plan to a trial but will not activate the plan. A trial will
599
+ # automatically begin its assigned payment plan after its 30th free day or
600
+ # immediately after calling <code>startPaidService</code>. </li> <li>
601
+ # <code>FREE</code> &mdash; The free plan is exclusive to the Cloud
602
+ # Identity SKU and does not incur any billing. </li> </ul>
554
603
  # Corresponds to the JSON property `planName`
555
604
  # @return [String]
556
605
  attr_accessor :plan_name
@@ -566,20 +615,24 @@ module Google
566
615
  @plan_name = args[:plan_name] if args.key?(:plan_name)
567
616
  end
568
617
 
569
- # In this version of the API, annual commitment plan's interval is one year.
570
- # Note: When billingMethod value is OFFLINE, the subscription property object
571
- # plan.commitmentInterval is omitted in all API responses.
618
+ # In this version of the API, annual commitment plan's interval is one
619
+ # year. <aside class="caution"> <strong>Note: </strong>When
620
+ # <code>billingMethod</code> value is <code>OFFLINE</code>, the
621
+ # subscription property object <code>plan.commitmentInterval</code> is
622
+ # omitted in all API responses. </aside>
572
623
  class CommitmentInterval
573
624
  include Google::Apis::Core::Hashable
574
625
 
575
- # An annual commitment plan's interval's endTime in milliseconds using the UNIX
576
- # Epoch format. See an example Epoch converter.
626
+ # An annual commitment plan&#39;s interval&#39;s <code>endTime</code> in
627
+ # milliseconds using the UNIX Epoch format. See an example <a
628
+ # href="http://www.epochconverter.com/">Epoch converter</a>.
577
629
  # Corresponds to the JSON property `endTime`
578
630
  # @return [Fixnum]
579
631
  attr_accessor :end_time
580
632
 
581
- # An annual commitment plan's interval's startTime in milliseconds using UNIX
582
- # Epoch format. See an example Epoch converter.
633
+ # An annual commitment plan's interval's <code>startTime</code> in
634
+ # milliseconds using UNIX Epoch format. See an example <a
635
+ # href="http://www.epochconverter.com/">Epoch converter</a>.
583
636
  # Corresponds to the JSON property `startTime`
584
637
  # @return [Fixnum]
585
638
  attr_accessor :start_time
@@ -597,20 +650,23 @@ module Google
597
650
  end
598
651
 
599
652
  # Read-only transfer related information for the subscription. For more
600
- # information, see retrieve transferable subscriptions for a customer.
653
+ # information, see <a
654
+ # href="/admin-sdk/reseller/v1/how-tos/manage_subscriptions#
655
+ # get_transferable_subscriptions">retrieve
656
+ # transferable subscriptions for a customer</a>.
601
657
  class TransferInfo
602
658
  include Google::Apis::Core::Hashable
603
659
 
604
- # When inserting a subscription, this is the minimum number of seats listed in
605
- # the transfer order for this product. For example, if the customer has 20 users,
606
- # the reseller cannot place a transfer order of 15 seats. The minimum is 20
607
- # seats.
660
+ # When inserting a subscription, this is the minimum number of seats listed
661
+ # in the transfer order for this product. For example, if the customer has
662
+ # 20 users, the reseller cannot place a transfer order of 15 seats. The
663
+ # minimum is 20 seats.
608
664
  # Corresponds to the JSON property `minimumTransferableSeats`
609
665
  # @return [Fixnum]
610
666
  attr_accessor :minimum_transferable_seats
611
667
 
612
- # The time when transfer token or intent to transfer will expire. The time is in
613
- # milliseconds using UNIX Epoch format.
668
+ # The time when transfer token or intent to transfer will expire. The time
669
+ # is in milliseconds using UNIX Epoch format.
614
670
  # Corresponds to the JSON property `transferabilityExpirationTime`
615
671
  # @return [Fixnum]
616
672
  attr_accessor :transferability_expiration_time
@@ -627,20 +683,23 @@ module Google
627
683
  end
628
684
 
629
685
  # The G Suite annual commitment and flexible payment plans can be in a 30-day
630
- # free trial. For more information, see the API concepts.
686
+ # free trial. For more information, see the <a
687
+ # href="/admin-sdk/reseller/v1/how-tos/concepts#plans">API concepts</a>.
631
688
  class TrialSettings
632
689
  include Google::Apis::Core::Hashable
633
690
 
634
- # Determines if a subscription's plan is in a 30-day free trial or not:
635
- # - true The plan is in trial.
636
- # - false The plan is not in trial.
691
+ # Determines if a subscription&#39;s plan is in a 30-day free trial or
692
+ # not:<ul><li><code>true</code> &mdash; The plan is in
693
+ # trial.</li><li><code>false</code> &mdash; The plan is not in
694
+ # trial.</li></ul>
637
695
  # Corresponds to the JSON property `isInTrial`
638
696
  # @return [Boolean]
639
697
  attr_accessor :is_in_trial
640
698
  alias_method :is_in_trial?, :is_in_trial
641
699
 
642
- # Date when the trial ends. The value is in milliseconds using the UNIX Epoch
643
- # format. See an example Epoch converter.
700
+ # Date when the trial ends. The value is in milliseconds using the UNIX
701
+ # Epoch format. See an example <a
702
+ # href="http://www.epochconverter.com/">Epoch converter</a>.
644
703
  # Corresponds to the JSON property `trialEndTime`
645
704
  # @return [Fixnum]
646
705
  attr_accessor :trial_end_time
@@ -661,14 +720,14 @@ module Google
661
720
  class Subscriptions
662
721
  include Google::Apis::Core::Hashable
663
722
 
664
- # Identifies the resource as a collection of subscriptions. Value: reseller#
665
- # subscriptions
723
+ # Identifies the resource as a collection of subscriptions. Value:
724
+ # reseller#subscriptions
666
725
  # Corresponds to the JSON property `kind`
667
726
  # @return [String]
668
727
  attr_accessor :kind
669
728
 
670
- # The continuation token, used to page through large result sets. Provide this
671
- # value in a subsequent request to return the next page of results.
729
+ # The continuation token, used to page through large result sets. Provide
730
+ # this value in a subsequent request to return the next page of results.
672
731
  # Corresponds to the JSON property `nextPageToken`
673
732
  # @return [String]
674
733
  attr_accessor :next_page_token