Skip to content

Commit bdba16d

Browse files
yoshi-automationyoshi-automation
committed
feat(androidenterprise): update the api
#### androidenterprise:v1 The following keys were added: - schemas.EnterpriseUpgradeEvent (Total Keys: 3) - schemas.Notification.properties.enterpriseUpgradeEvent.$ref (Total Keys: 1)
1 parent e2b1940 commit bdba16d

File tree

2 files changed

+101
-3
lines changed

2 files changed

+101
-3
lines changed

‎docs/dyn/androidenterprise_v1.enterprises.html

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ <h2>Instance Methods</h2>
8989
<p class="toc_element">
9090
<code><a href="#enroll">enroll(token, body=None, x__xgafv=None)</a></code></p>
9191
<p class="firstline">Enrolls an enterprise with the calling EMM.</p>
92+
<p class="toc_element">
93+
<code><a href="#generateEnterpriseUpgradeUrl">generateEnterpriseUpgradeUrl(enterpriseId, adminEmail=None, allowedDomains=None, x__xgafv=None)</a></code></p>
94+
<p class="firstline">Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.</p>
9295
<p class="toc_element">
9396
<code><a href="#generateSignupUrl">generateSignupUrl(adminEmail=None, allowedDomains=None, callbackUrl=None, x__xgafv=None)</a></code></p>
9497
<p class="firstline">Generates a sign-up URL.</p>
@@ -271,6 +274,27 @@ <h3>Method Details</h3>
271274
}</pre>
272275
</div>
273276

277+
<div class="method">
278+
<code class="details" id="generateEnterpriseUpgradeUrl">generateEnterpriseUpgradeUrl(enterpriseId, adminEmail=None, allowedDomains=None, x__xgafv=None)</code>
279+
<pre>Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.
280+
281+
Args:
282+
enterpriseId: string, Required. The ID of the enterprise. (required)
283+
adminEmail: string, Optional. Email address used to prefill the admin field of the enterprise signup form as part of the upgrade process. This value is a hint only and can be altered by the user. Personal email addresses are not allowed. If `allowedDomains` is non-empty then this must belong to one of the `allowedDomains`.
284+
allowedDomains: string, Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has `*.` prefixed to the domain name (e.g. *.example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are not allowed. (repeated)
285+
x__xgafv: string, V1 error format.
286+
Allowed values
287+
1 - v1 error format
288+
2 - v2 error format
289+
290+
Returns:
291+
An object of the form:
292+
293+
{ # Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.
294+
&quot;url&quot;: &quot;A String&quot;, # A URL for an enterprise admin to upgrade their enterprise. The page can&#x27;t be rendered in an iframe.
295+
}</pre>
296+
</div>
297+
274298
<div class="method">
275299
<code class="details" id="generateSignupUrl">generateSignupUrl(adminEmail=None, allowedDomains=None, callbackUrl=None, x__xgafv=None)</code>
276300
<pre>Generates a sign-up URL.
@@ -459,6 +483,9 @@ <h3>Method Details</h3>
459483
&quot;userId&quot;: &quot;A String&quot;, # The ID of the user. This field will always be present.
460484
},
461485
&quot;enterpriseId&quot;: &quot;A String&quot;, # The ID of the enterprise for which the notification is sent. This will always be present.
486+
&quot;enterpriseUpgradeEvent&quot;: { # An event generated when an enterprise is upgraded. **Note:** This feature is not generally available. # Notifications about enterprise upgrade. **Note:** This feature is not generally available.
487+
&quot;upgradeState&quot;: &quot;A String&quot;, # The upgrade state.
488+
},
462489
&quot;installFailureEvent&quot;: { # An event generated when an app installation failed on a device # Notifications about an app installation failure.
463490
&quot;deviceId&quot;: &quot;A String&quot;, # The Android ID of the device. This field will always be present.
464491
&quot;failureDetails&quot;: &quot;A String&quot;, # Additional details on the failure if applicable.

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

Lines changed: 74 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,41 @@
468468
"https://www.googleapis.com/auth/androidenterprise"
469469
]
470470
},
471+
"generateEnterpriseUpgradeUrl": {
472+
"description": "Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.",
473+
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/generateEnterpriseUpgradeUrl",
474+
"httpMethod": "POST",
475+
"id": "androidenterprise.enterprises.generateEnterpriseUpgradeUrl",
476+
"parameterOrder": [
477+
"enterpriseId"
478+
],
479+
"parameters": {
480+
"adminEmail": {
481+
"description": "Optional. Email address used to prefill the admin field of the enterprise signup form as part of the upgrade process. This value is a hint only and can be altered by the user. Personal email addresses are not allowed. If `allowedDomains` is non-empty then this must belong to one of the `allowedDomains`.",
482+
"location": "query",
483+
"type": "string"
484+
},
485+
"allowedDomains": {
486+
"description": "Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has `*.` prefixed to the domain name (e.g. *.example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are not allowed.",
487+
"location": "query",
488+
"repeated": true,
489+
"type": "string"
490+
},
491+
"enterpriseId": {
492+
"description": "Required. The ID of the enterprise.",
493+
"location": "path",
494+
"required": true,
495+
"type": "string"
496+
}
497+
},
498+
"path": "androidenterprise/v1/enterprises/{enterpriseId}/generateEnterpriseUpgradeUrl",
499+
"response": {
500+
"$ref": "GenerateEnterpriseUpgradeUrlResponse"
501+
},
502+
"scopes": [
503+
"https://www.googleapis.com/auth/androidenterprise"
504+
]
505+
},
471506
"generateSignupUrl": {
472507
"description": "Generates a sign-up URL.",
473508
"flatPath": "androidenterprise/v1/enterprises/signupUrl",
@@ -2656,7 +2691,7 @@
26562691
}
26572692
}
26582693
},
2659-
"revision": "20250213",
2694+
"revision": "20250302",
26602695
"rootUrl": "https://androidenterprise.googleapis.com/",
26612696
"schemas": {
26622697
"Administrator": {
@@ -3395,6 +3430,25 @@
33953430
},
33963431
"type": "object"
33973432
},
3433+
"EnterpriseUpgradeEvent": {
3434+
"description": "An event generated when an enterprise is upgraded. **Note:** This feature is not generally available.",
3435+
"id": "EnterpriseUpgradeEvent",
3436+
"properties": {
3437+
"upgradeState": {
3438+
"description": "The upgrade state.",
3439+
"enum": [
3440+
"upgradeStateUnspecified",
3441+
"upgradeStateSucceeded"
3442+
],
3443+
"enumDescriptions": [
3444+
"Unspecified. This value is not used.",
3445+
"The upgrade has succeeded."
3446+
],
3447+
"type": "string"
3448+
}
3449+
},
3450+
"type": "object"
3451+
},
33983452
"EnterprisesListResponse": {
33993453
"id": "EnterprisesListResponse",
34003454
"properties": {
@@ -3460,6 +3514,17 @@
34603514
},
34613515
"type": "object"
34623516
},
3517+
"GenerateEnterpriseUpgradeUrlResponse": {
3518+
"description": "Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.",
3519+
"id": "GenerateEnterpriseUpgradeUrlResponse",
3520+
"properties": {
3521+
"url": {
3522+
"description": "A URL for an enterprise admin to upgrade their enterprise. The page can't be rendered in an iframe.",
3523+
"type": "string"
3524+
}
3525+
},
3526+
"type": "object"
3527+
},
34633528
"GoogleAuthenticationSettings": {
34643529
"description": "Contains settings for Google-provided user authentication.",
34653530
"id": "GoogleAuthenticationSettings",
@@ -3943,6 +4008,10 @@
39434008
"description": "The ID of the enterprise for which the notification is sent. This will always be present.",
39444009
"type": "string"
39454010
},
4011+
"enterpriseUpgradeEvent": {
4012+
"$ref": "EnterpriseUpgradeEvent",
4013+
"description": "Notifications about enterprise upgrade. **Note:** This feature is not generally available."
4014+
},
39464015
"installFailureEvent": {
39474016
"$ref": "InstallFailureEvent",
39484017
"description": "Notifications about an app installation failure."
@@ -3967,7 +4036,8 @@
39674036
"appRestricionsSchemaChange",
39684037
"productAvailabilityChange",
39694038
"newDevice",
3970-
"deviceReportUpdate"
4039+
"deviceReportUpdate",
4040+
"enterpriseUpgrade"
39714041
],
39724042
"enumDescriptions": [
39734043
"",
@@ -3979,7 +4049,8 @@
39794049
"Notification about new app restrictions schema change.",
39804050
"Notification about product availability change.",
39814051
"Notification about a new device.",
3982-
"Notification about an updated device report."
4052+
"Notification about an updated device report.",
4053+
"Notification about an enterprise upgrade. **Note:** This feature is not generally available."
39834054
],
39844055
"type": "string"
39854056
},

0 commit comments

Comments
 (0)