Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- GroupLicense
- StoreLayoutPagesListResponse
- EnterpriseAccount
- CollectionsListResponse
- AppRestrictionsSchemaRestrictionRestrictionValue
- DeviceState
- GroupLicenseUsersListResponse
- TokenPagination
- ApprovalURLInfo
- StoreLayoutClustersListResponse
- StoreCluster
- PageInfo
- ProductPermission
- Device
- InstallsListResponse
- AppRestrictionsSchemaRestriction
- UsersListResponse
- AppVersion
- GroupLicensesListResponse
- Collection
- ProductSet
- Install
- User
- ProductsGenerateApprovalURLResponse
- StorePage
- EnterprisesSendTestPushNotificationResponse
- EnterprisesListResponse
- AppRestrictionsSchema
- LocalizedText
- UserToken
- DevicesListResponse
- Enterprise
- StoreLayout
- Product
- EntitlementsListResponse
- ProductPermissions
- Permission
- ProductsApproveRequest
- CollectionViewersListResponse
- Entitlement
- ProductsListResponse
- androidEnterpriseService :: ServiceConfig
- androidEnterpriseScope :: Proxy '["https://www.googleapis.com/auth/androidenterprise"]
- data GroupLicense
- groupLicense :: GroupLicense
- glKind :: Lens' GroupLicense Text
- glNumProvisioned :: Lens' GroupLicense (Maybe Int32)
- glNumPurchased :: Lens' GroupLicense (Maybe Int32)
- glApproval :: Lens' GroupLicense (Maybe Text)
- glProductId :: Lens' GroupLicense (Maybe Text)
- glAcquisitionKind :: Lens' GroupLicense (Maybe Text)
- data StoreLayoutPagesListResponse
- storeLayoutPagesListResponse :: StoreLayoutPagesListResponse
- slplrKind :: Lens' StoreLayoutPagesListResponse Text
- slplrPage :: Lens' StoreLayoutPagesListResponse [StorePage]
- data EnterpriseAccount
- enterpriseAccount :: EnterpriseAccount
- eaKind :: Lens' EnterpriseAccount Text
- eaAccountEmail :: Lens' EnterpriseAccount (Maybe Text)
- data CollectionsListResponse
- collectionsListResponse :: CollectionsListResponse
- clrKind :: Lens' CollectionsListResponse Text
- clrCollection :: Lens' CollectionsListResponse [Collection]
- data AppRestrictionsSchemaRestrictionRestrictionValue
- appRestrictionsSchemaRestrictionRestrictionValue :: AppRestrictionsSchemaRestrictionRestrictionValue
- arsrrvValueMultiselect :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue [Text]
- arsrrvValueBool :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue (Maybe Bool)
- arsrrvValueInteger :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue (Maybe Int32)
- arsrrvType :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue (Maybe Text)
- arsrrvValueString :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue (Maybe Text)
- data DeviceState
- deviceState :: DeviceState
- dsKind :: Lens' DeviceState Text
- dsAccountState :: Lens' DeviceState (Maybe Text)
- data GroupLicenseUsersListResponse
- groupLicenseUsersListResponse :: GroupLicenseUsersListResponse
- glulrKind :: Lens' GroupLicenseUsersListResponse Text
- glulrUser :: Lens' GroupLicenseUsersListResponse [User]
- data TokenPagination
- tokenPagination :: TokenPagination
- tpNextPageToken :: Lens' TokenPagination (Maybe Text)
- tpPreviousPageToken :: Lens' TokenPagination (Maybe Text)
- data ApprovalURLInfo
- approvalURLInfo :: ApprovalURLInfo
- auiApprovalURL :: Lens' ApprovalURLInfo (Maybe Text)
- auiKind :: Lens' ApprovalURLInfo Text
- data StoreLayoutClustersListResponse
- storeLayoutClustersListResponse :: StoreLayoutClustersListResponse
- slclrCluster :: Lens' StoreLayoutClustersListResponse [StoreCluster]
- slclrKind :: Lens' StoreLayoutClustersListResponse Text
- data StoreCluster
- storeCluster :: StoreCluster
- scKind :: Lens' StoreCluster Text
- scName :: Lens' StoreCluster [LocalizedText]
- scOrderInPage :: Lens' StoreCluster (Maybe Text)
- scId :: Lens' StoreCluster (Maybe Text)
- scProductId :: Lens' StoreCluster [Text]
- data PageInfo
- pageInfo :: PageInfo
- piResultPerPage :: Lens' PageInfo (Maybe Int32)
- piTotalResults :: Lens' PageInfo (Maybe Int32)
- piStartIndex :: Lens' PageInfo (Maybe Int32)
- data ProductPermission
- productPermission :: ProductPermission
- ppState :: Lens' ProductPermission (Maybe Text)
- ppPermissionId :: Lens' ProductPermission (Maybe Text)
- data Device
- device :: Device
- dKind :: Lens' Device Text
- dManagementType :: Lens' Device (Maybe Text)
- dAndroidId :: Lens' Device (Maybe Text)
- data InstallsListResponse
- installsListResponse :: InstallsListResponse
- ilrKind :: Lens' InstallsListResponse Text
- ilrInstall :: Lens' InstallsListResponse [Install]
- data AppRestrictionsSchemaRestriction
- appRestrictionsSchemaRestriction :: AppRestrictionsSchemaRestriction
- arsrRestrictionType :: Lens' AppRestrictionsSchemaRestriction (Maybe Text)
- arsrEntry :: Lens' AppRestrictionsSchemaRestriction [Text]
- arsrKey :: Lens' AppRestrictionsSchemaRestriction (Maybe Text)
- arsrEntryValue :: Lens' AppRestrictionsSchemaRestriction [Text]
- arsrDefaultValue :: Lens' AppRestrictionsSchemaRestriction (Maybe AppRestrictionsSchemaRestrictionRestrictionValue)
- arsrTitle :: Lens' AppRestrictionsSchemaRestriction (Maybe Text)
- arsrDescription :: Lens' AppRestrictionsSchemaRestriction (Maybe Text)
- data UsersListResponse
- usersListResponse :: UsersListResponse
- ulrKind :: Lens' UsersListResponse Text
- ulrUser :: Lens' UsersListResponse [User]
- data AppVersion
- appVersion :: AppVersion
- avVersionCode :: Lens' AppVersion (Maybe Int32)
- avVersionString :: Lens' AppVersion (Maybe Text)
- data GroupLicensesListResponse
- groupLicensesListResponse :: GroupLicensesListResponse
- gllrGroupLicense :: Lens' GroupLicensesListResponse [GroupLicense]
- gllrKind :: Lens' GroupLicensesListResponse Text
- data Collection
- collection :: Collection
- colKind :: Lens' Collection Text
- colCollectionId :: Lens' Collection (Maybe Text)
- colVisibility :: Lens' Collection (Maybe Text)
- colName :: Lens' Collection (Maybe Text)
- colProductId :: Lens' Collection [Text]
- data ProductSet
- productSet :: ProductSet
- psKind :: Lens' ProductSet Text
- psProductId :: Lens' ProductSet [Text]
- data Install
- install :: Install
- iVersionCode :: Lens' Install (Maybe Int32)
- iKind :: Lens' Install Text
- iInstallState :: Lens' Install (Maybe Text)
- iProductId :: Lens' Install (Maybe Text)
- data User
- user :: User
- uKind :: Lens' User Text
- uId :: Lens' User (Maybe Text)
- uPrimaryEmail :: Lens' User (Maybe Text)
- data ProductsGenerateApprovalURLResponse
- productsGenerateApprovalURLResponse :: ProductsGenerateApprovalURLResponse
- pgaurURL :: Lens' ProductsGenerateApprovalURLResponse (Maybe Text)
- data StorePage
- storePage :: StorePage
- spKind :: Lens' StorePage Text
- spLink :: Lens' StorePage [Text]
- spName :: Lens' StorePage [LocalizedText]
- spId :: Lens' StorePage (Maybe Text)
- data EnterprisesSendTestPushNotificationResponse
- enterprisesSendTestPushNotificationResponse :: EnterprisesSendTestPushNotificationResponse
- estpnrTopicName :: Lens' EnterprisesSendTestPushNotificationResponse (Maybe Text)
- estpnrMessageId :: Lens' EnterprisesSendTestPushNotificationResponse (Maybe Text)
- data EnterprisesListResponse
- enterprisesListResponse :: EnterprisesListResponse
- elrKind :: Lens' EnterprisesListResponse Text
- elrEnterprise :: Lens' EnterprisesListResponse [Enterprise]
- data AppRestrictionsSchema
- appRestrictionsSchema :: AppRestrictionsSchema
- arsKind :: Lens' AppRestrictionsSchema Text
- arsRestrictions :: Lens' AppRestrictionsSchema [AppRestrictionsSchemaRestriction]
- data LocalizedText
- localizedText :: LocalizedText
- ltText :: Lens' LocalizedText (Maybe Text)
- ltLocale :: Lens' LocalizedText (Maybe Text)
- data UserToken
- userToken :: UserToken
- utKind :: Lens' UserToken Text
- utToken :: Lens' UserToken (Maybe Text)
- utUserId :: Lens' UserToken (Maybe Text)
- data DevicesListResponse
- devicesListResponse :: DevicesListResponse
- dlrKind :: Lens' DevicesListResponse Text
- dlrDevice :: Lens' DevicesListResponse [Device]
- data Enterprise
- enterprise :: Enterprise
- eKind :: Lens' Enterprise Text
- ePrimaryDomain :: Lens' Enterprise (Maybe Text)
- eName :: Lens' Enterprise (Maybe Text)
- eId :: Lens' Enterprise (Maybe Text)
- data StoreLayout
- storeLayout :: StoreLayout
- slKind :: Lens' StoreLayout Text
- slHomepageId :: Lens' StoreLayout (Maybe Text)
- data Product
- product :: Product
- pSmallIconURL :: Lens' Product (Maybe Text)
- pAuthorName :: Lens' Product (Maybe Text)
- pKind :: Lens' Product Text
- pWorkDetailsURL :: Lens' Product (Maybe Text)
- pRequiresContainerApp :: Lens' Product (Maybe Bool)
- pAppVersion :: Lens' Product [AppVersion]
- pProductPricing :: Lens' Product (Maybe Text)
- pDistributionChannel :: Lens' Product (Maybe Text)
- pIconURL :: Lens' Product (Maybe Text)
- pTitle :: Lens' Product (Maybe Text)
- pProductId :: Lens' Product (Maybe Text)
- pDetailsURL :: Lens' Product (Maybe Text)
- data EntitlementsListResponse
- entitlementsListResponse :: EntitlementsListResponse
- entKind :: Lens' EntitlementsListResponse Text
- entEntitlement :: Lens' EntitlementsListResponse [Entitlement]
- data ProductPermissions
- productPermissions :: ProductPermissions
- ppKind :: Lens' ProductPermissions Text
- ppPermission :: Lens' ProductPermissions [ProductPermission]
- ppProductId :: Lens' ProductPermissions (Maybe Text)
- data Permission
- permission :: Permission
- perKind :: Lens' Permission Text
- perName :: Lens' Permission (Maybe Text)
- perDescription :: Lens' Permission (Maybe Text)
- perPermissionId :: Lens' Permission (Maybe Text)
- data ProductsApproveRequest
- productsApproveRequest :: ProductsApproveRequest
- parApprovalURLInfo :: Lens' ProductsApproveRequest (Maybe ApprovalURLInfo)
- data CollectionViewersListResponse
- collectionViewersListResponse :: CollectionViewersListResponse
- cvlrKind :: Lens' CollectionViewersListResponse Text
- cvlrUser :: Lens' CollectionViewersListResponse [User]
- data Entitlement
- entitlement :: Entitlement
- eeKind :: Lens' Entitlement Text
- eeReason :: Lens' Entitlement (Maybe Text)
- eeProductId :: Lens' Entitlement (Maybe Text)
- data ProductsListResponse
- productsListResponse :: ProductsListResponse
- plrTokenPagination :: Lens' ProductsListResponse (Maybe TokenPagination)
- plrPageInfo :: Lens' ProductsListResponse (Maybe PageInfo)
- plrKind :: Lens' ProductsListResponse Text
- plrProduct :: Lens' ProductsListResponse [Product]
Service Configuration
androidEnterpriseService :: ServiceConfig Source #
Default request referring to version v1
of the Google Play EMM API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
androidEnterpriseScope :: Proxy '["https://www.googleapis.com/auth/androidenterprise"] Source #
Manage corporate Android devices
GroupLicense
data GroupLicense Source #
A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play by the enterprise admin. The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product. Group license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play.
See: groupLicense
smart constructor.
groupLicense :: GroupLicense Source #
Creates a value of GroupLicense
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
glKind :: Lens' GroupLicense Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".
glNumProvisioned :: Lens' GroupLicense (Maybe Int32) Source #
The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.
glNumPurchased :: Lens' GroupLicense (Maybe Int32) Source #
The number of purchased licenses (possibly in multiple purchases). If this field is omitted then there is no limit on the number of licenses that can be provisioned (e.g. if the acquisition kind is "free").
glApproval :: Lens' GroupLicense (Maybe Text) Source #
Whether the product to which this group license relates is currently approved by the enterprise, as either "approved" or "unapproved". Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections and new entitlements to them should not normally be created.
glProductId :: Lens' GroupLicense (Maybe Text) Source #
The ID of the product that the license is for, e.g. "app:com.google.android.gm".
glAcquisitionKind :: Lens' GroupLicense (Maybe Text) Source #
How this group license was acquired. "bulkPurchase" means that this group license object was created because the enterprise purchased licenses for this product; this is "free" otherwise (for free products).
StoreLayoutPagesListResponse
data StoreLayoutPagesListResponse Source #
The store page resources for the enterprise.
See: storeLayoutPagesListResponse
smart constructor.
storeLayoutPagesListResponse :: StoreLayoutPagesListResponse Source #
Creates a value of StoreLayoutPagesListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slplrKind :: Lens' StoreLayoutPagesListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutPagesListResponse".
EnterpriseAccount
data EnterpriseAccount Source #
A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
See: enterpriseAccount
smart constructor.
enterpriseAccount :: EnterpriseAccount Source #
Creates a value of EnterpriseAccount
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eaKind :: Lens' EnterpriseAccount Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
eaAccountEmail :: Lens' EnterpriseAccount (Maybe Text) Source #
The email address of the service account.
CollectionsListResponse
data CollectionsListResponse Source #
The collection resources for the enterprise.
See: collectionsListResponse
smart constructor.
collectionsListResponse :: CollectionsListResponse Source #
Creates a value of CollectionsListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clrKind :: Lens' CollectionsListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionsListResponse".
clrCollection :: Lens' CollectionsListResponse [Collection] Source #
An ordered collection of products which can be made visible on the Google Play Store to a selected group of users.
AppRestrictionsSchemaRestrictionRestrictionValue
data AppRestrictionsSchemaRestrictionRestrictionValue Source #
A typed value for the restriction.
See: appRestrictionsSchemaRestrictionRestrictionValue
smart constructor.
appRestrictionsSchemaRestrictionRestrictionValue :: AppRestrictionsSchemaRestrictionRestrictionValue Source #
Creates a value of AppRestrictionsSchemaRestrictionRestrictionValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arsrrvValueMultiselect :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue [Text] Source #
The list of string values - this will only be present if type is multiselect.
arsrrvValueBool :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue (Maybe Bool) Source #
The boolean value - this will only be present if type is bool.
arsrrvValueInteger :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue (Maybe Int32) Source #
The integer value - this will only be present if type is integer.
arsrrvType :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue (Maybe Text) Source #
The type of the value being provided.
arsrrvValueString :: Lens' AppRestrictionsSchemaRestrictionRestrictionValue (Maybe Text) Source #
The string value - this will be present for types string, choice and hidden.
DeviceState
data DeviceState Source #
The state of a user's device, as accessed by the getState and setState methods on device resources.
See: deviceState
smart constructor.
deviceState :: DeviceState Source #
Creates a value of DeviceState
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsKind :: Lens' DeviceState Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
dsAccountState :: Lens' DeviceState (Maybe Text) Source #
The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
GroupLicenseUsersListResponse
data GroupLicenseUsersListResponse Source #
The user resources for the group license.
See: groupLicenseUsersListResponse
smart constructor.
groupLicenseUsersListResponse :: GroupLicenseUsersListResponse Source #
Creates a value of GroupLicenseUsersListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
glulrKind :: Lens' GroupLicenseUsersListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicenseUsersListResponse".
TokenPagination
data TokenPagination Source #
tokenPagination :: TokenPagination Source #
Creates a value of TokenPagination
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ApprovalURLInfo
data ApprovalURLInfo Source #
Information on an approval URL.
See: approvalURLInfo
smart constructor.
approvalURLInfo :: ApprovalURLInfo Source #
Creates a value of ApprovalURLInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
auiApprovalURL :: Lens' ApprovalURLInfo (Maybe Text) Source #
A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call.
auiKind :: Lens' ApprovalURLInfo Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#approvalUrlInfo".
StoreLayoutClustersListResponse
data StoreLayoutClustersListResponse Source #
The store page resources for the enterprise.
See: storeLayoutClustersListResponse
smart constructor.
storeLayoutClustersListResponse :: StoreLayoutClustersListResponse Source #
Creates a value of StoreLayoutClustersListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slclrCluster :: Lens' StoreLayoutClustersListResponse [StoreCluster] Source #
A store cluster of an enterprise.
slclrKind :: Lens' StoreLayoutClustersListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutClustersListResponse".
StoreCluster
data StoreCluster Source #
Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
See: storeCluster
smart constructor.
storeCluster :: StoreCluster Source #
Creates a value of StoreCluster
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scKind :: Lens' StoreCluster Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
scName :: Lens' StoreCluster [LocalizedText] Source #
Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
scOrderInPage :: Lens' StoreCluster (Maybe Text) Source #
String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
scId :: Lens' StoreCluster (Maybe Text) Source #
Unique ID of this cluster. Assigned by the server. Immutable once assigned.
scProductId :: Lens' StoreCluster [Text] Source #
List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
PageInfo
Creates a value of PageInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ProductPermission
data ProductPermission Source #
A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin. The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted.
See: productPermission
smart constructor.
productPermission :: ProductPermission Source #
Creates a value of ProductPermission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ppState :: Lens' ProductPermission (Maybe Text) Source #
Whether the permission has been accepted or not.
ppPermissionId :: Lens' ProductPermission (Maybe Text) Source #
An opaque string uniquely identifying the permission.
Device
A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user. This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
See: device
smart constructor.
Creates a value of Device
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dKind :: Lens' Device Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
dManagementType :: Lens' Device (Maybe Text) Source #
The mechanism by which this device is managed by the EMM. "managedDevice" means that the EMM's app is a device owner. "managedProfile" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the EMM's app is managing the Android for Work container app on the device. ?unmanagedProfile? means that the EMM?s app is managing a managed user on an unmanaged device
dAndroidId :: Lens' Device (Maybe Text) Source #
The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
InstallsListResponse
data InstallsListResponse Source #
The install resources for the device.
See: installsListResponse
smart constructor.
installsListResponse :: InstallsListResponse Source #
Creates a value of InstallsListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ilrKind :: Lens' InstallsListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#installsListResponse".
ilrInstall :: Lens' InstallsListResponse [Install] Source #
An installation of an app for a user on a specific device. The existence of an install implies that the user must have an entitlement to the app.
AppRestrictionsSchemaRestriction
data AppRestrictionsSchemaRestriction Source #
A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.
See: appRestrictionsSchemaRestriction
smart constructor.
appRestrictionsSchemaRestriction :: AppRestrictionsSchemaRestriction Source #
Creates a value of AppRestrictionsSchemaRestriction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arsrRestrictionType :: Lens' AppRestrictionsSchemaRestriction (Maybe Text) Source #
The type of the restriction.
arsrEntry :: Lens' AppRestrictionsSchemaRestriction [Text] Source #
For choice or multiselect restrictions, the list of possible entries' human-readable names.
arsrKey :: Lens' AppRestrictionsSchemaRestriction (Maybe Text) Source #
The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname".
arsrEntryValue :: Lens' AppRestrictionsSchemaRestriction [Text] Source #
For choice or multiselect restrictions, the list of possible entries' machine-readable values.
arsrDefaultValue :: Lens' AppRestrictionsSchemaRestriction (Maybe AppRestrictionsSchemaRestrictionRestrictionValue) Source #
The default value of the restriction.
arsrTitle :: Lens' AppRestrictionsSchemaRestriction (Maybe Text) Source #
The name of the restriction.
arsrDescription :: Lens' AppRestrictionsSchemaRestriction (Maybe Text) Source #
A longer description of the restriction, giving more detail of what it affects.
UsersListResponse
data UsersListResponse Source #
The matching user resources.
See: usersListResponse
smart constructor.
usersListResponse :: UsersListResponse Source #
Creates a value of UsersListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ulrKind :: Lens' UsersListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse".
AppVersion
data AppVersion Source #
This represents a single version of the app.
See: appVersion
smart constructor.
appVersion :: AppVersion Source #
Creates a value of AppVersion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
avVersionCode :: Lens' AppVersion (Maybe Int32) Source #
Unique increasing identifier for the app version.
avVersionString :: Lens' AppVersion (Maybe Text) Source #
The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4").
GroupLicensesListResponse
data GroupLicensesListResponse Source #
The grouplicense resources for the enterprise.
See: groupLicensesListResponse
smart constructor.
groupLicensesListResponse :: GroupLicensesListResponse Source #
Creates a value of GroupLicensesListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gllrGroupLicense :: Lens' GroupLicensesListResponse [GroupLicense] Source #
A group license for a product approved for use in the enterprise.
gllrKind :: Lens' GroupLicensesListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicensesListResponse".
Collection
data Collection Source #
A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user. Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
See: collection
smart constructor.
collection :: Collection Source #
Creates a value of Collection
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
colKind :: Lens' Collection Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
colCollectionId :: Lens' Collection (Maybe Text) Source #
Arbitrary unique ID, allocated by the API on creation.
colVisibility :: Lens' Collection (Maybe Text) Source #
Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain. The "allUsers" setting is deprecated, and will be removed.
colName :: Lens' Collection (Maybe Text) Source #
A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
colProductId :: Lens' Collection [Text] Source #
The IDs of the products in the collection, in the order in which they should be displayed.
ProductSet
data ProductSet Source #
A set of products.
See: productSet
smart constructor.
productSet :: ProductSet Source #
Creates a value of ProductSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psKind :: Lens' ProductSet Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
psProductId :: Lens' ProductSet [Text] Source #
The list of product IDs making up the set of products.
Install
The existence of an install resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app then an attempt is made to create one. If this fails (e.g. because the app is not free and there is no available license) then the creation of the install fails. The API can also be used to update an installed app. If the update method is used on an existing install then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app; the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves.
See: install
smart constructor.
Creates a value of Install
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iVersionCode :: Lens' Install (Maybe Int32) Source #
The version of the installed product. Guaranteed to be set only if the install state is "installed".
iKind :: Lens' Install Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install".
iInstallState :: Lens' Install (Maybe Text) Source #
Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only.
iProductId :: Lens' Install (Maybe Text) Source #
The ID of the product that the install is for, e.g. "app:com.google.android.gm".
User
A user resource represents an individual user within the enterprise's domain. Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
See: user
smart constructor.
Creates a value of User
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uKind :: Lens' User Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
uPrimaryEmail :: Lens' User (Maybe Text) Source #
The user's primary email, e.g. "jsmith'example.com".
ProductsGenerateApprovalURLResponse
data ProductsGenerateApprovalURLResponse Source #
productsGenerateApprovalURLResponse :: ProductsGenerateApprovalURLResponse Source #
Creates a value of ProductsGenerateApprovalURLResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pgaurURL :: Lens' ProductsGenerateApprovalURLResponse (Maybe Text) Source #
A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.
StorePage
Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
See: storePage
smart constructor.
spKind :: Lens' StorePage Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
spLink :: Lens' StorePage [Text] Source #
Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages. No attempt is made to verify that all pages are reachable from the homepage.
spName :: Lens' StorePage [LocalizedText] Source #
Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
spId :: Lens' StorePage (Maybe Text) Source #
Unique ID of this page. Assigned by the server. Immutable once assigned.
EnterprisesSendTestPushNotificationResponse
data EnterprisesSendTestPushNotificationResponse Source #
enterprisesSendTestPushNotificationResponse :: EnterprisesSendTestPushNotificationResponse Source #
Creates a value of EnterprisesSendTestPushNotificationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
estpnrTopicName :: Lens' EnterprisesSendTestPushNotificationResponse (Maybe Text) Source #
The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent.
estpnrMessageId :: Lens' EnterprisesSendTestPushNotificationResponse (Maybe Text) Source #
The message ID of the test push notification that was sent.
EnterprisesListResponse
data EnterprisesListResponse Source #
The matching enterprise resources.
See: enterprisesListResponse
smart constructor.
enterprisesListResponse :: EnterprisesListResponse Source #
Creates a value of EnterprisesListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
elrKind :: Lens' EnterprisesListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse".
elrEnterprise :: Lens' EnterprisesListResponse [Enterprise] Source #
An enterprise.
AppRestrictionsSchema
data AppRestrictionsSchema Source #
Represents the list of app restrictions available to be pre-configured for the product.
See: appRestrictionsSchema
smart constructor.
appRestrictionsSchema :: AppRestrictionsSchema Source #
Creates a value of AppRestrictionsSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arsKind :: Lens' AppRestrictionsSchema Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#appRestrictionsSchema".
arsRestrictions :: Lens' AppRestrictionsSchema [AppRestrictionsSchemaRestriction] Source #
The set of restrictions that make up this schema.
LocalizedText
data LocalizedText Source #
A localized string with its locale.
See: localizedText
smart constructor.
localizedText :: LocalizedText Source #
Creates a value of LocalizedText
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltLocale :: Lens' LocalizedText (Maybe Text) Source #
The BCP47 tag for a locale. (e.g. "en-US", "de").
UserToken
A UserToken is used by a user when setting up a managed device or profile with their work account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded.
See: userToken
smart constructor.
utKind :: Lens' UserToken Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken".
utToken :: Lens' UserToken (Maybe Text) Source #
The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0.
DevicesListResponse
data DevicesListResponse Source #
The device resources for the user.
See: devicesListResponse
smart constructor.
devicesListResponse :: DevicesListResponse Source #
Creates a value of DevicesListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dlrKind :: Lens' DevicesListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse".
Enterprise
data Enterprise Source #
An enterprise resource represents a binding between an organization and their EMM. To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise. After calling enroll the EMM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). The EMM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the EMM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
See: enterprise
smart constructor.
enterprise :: Enterprise Source #
Creates a value of Enterprise
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eKind :: Lens' Enterprise Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
ePrimaryDomain :: Lens' Enterprise (Maybe Text) Source #
The enterprise's primary domain, e.g. "example.com".
StoreLayout
data StoreLayout Source #
General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
See: storeLayout
smart constructor.
storeLayout :: StoreLayout Source #
Creates a value of StoreLayout
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slKind :: Lens' StoreLayout Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
slHomepageId :: Lens' StoreLayout (Maybe Text) Source #
The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store. If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store. If there exists at least one page, this field must be set to the ID of a valid page.
Product
A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.
See: product
smart constructor.
Creates a value of Product
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pSmallIconURL :: Lens' Product (Maybe Text) Source #
A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px.
pAuthorName :: Lens' Product (Maybe Text) Source #
The name of the author of the product (e.g. the app developer).
pKind :: Lens' Product Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product".
pWorkDetailsURL :: Lens' Product (Maybe Text) Source #
A link to the Google Play for Work details page for the product, for use by an Enterprise administrator.
pRequiresContainerApp :: Lens' Product (Maybe Bool) Source #
Whether this app can only be installed on devices using the Android for Work container app.
pAppVersion :: Lens' Product [AppVersion] Source #
App versions currently available for this product. The returned list contains only public versions. Alpha and beta versions are not included.
pProductPricing :: Lens' Product (Maybe Text) Source #
Whether this product is free, free with in-app purchases, or paid.
pDistributionChannel :: Lens' Product (Maybe Text) Source #
How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play Store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted.
pIconURL :: Lens' Product (Maybe Text) Source #
A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px.
pProductId :: Lens' Product (Maybe Text) Source #
A string of the form app:. For example, app:com.google.android.gm represents the Gmail app.
pDetailsURL :: Lens' Product (Maybe Text) Source #
A link to the (consumer) Google Play details page for the product.
EntitlementsListResponse
data EntitlementsListResponse Source #
The entitlement resources for the user.
See: entitlementsListResponse
smart constructor.
entitlementsListResponse :: EntitlementsListResponse Source #
Creates a value of EntitlementsListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
entKind :: Lens' EntitlementsListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlementsListResponse".
entEntitlement :: Lens' EntitlementsListResponse [Entitlement] Source #
An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to.
ProductPermissions
data ProductPermissions Source #
Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
See: productPermissions
smart constructor.
productPermissions :: ProductPermissions Source #
Creates a value of ProductPermissions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ppKind :: Lens' ProductPermissions Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions".
ppPermission :: Lens' ProductPermissions [ProductPermission] Source #
The permissions required by the app.
ppProductId :: Lens' ProductPermissions (Maybe Text) Source #
The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
Permission
data Permission Source #
A permission represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created. The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the EMM user interface when obtaining consent from the enterprise.
See: permission
smart constructor.
permission :: Permission Source #
Creates a value of Permission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
perKind :: Lens' Permission Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#permission".
perDescription :: Lens' Permission (Maybe Text) Source #
A longer description of the permissions giving more details of what it affects.
perPermissionId :: Lens' Permission (Maybe Text) Source #
An opaque string uniquely identifying the permission.
ProductsApproveRequest
productsApproveRequest :: ProductsApproveRequest Source #
Creates a value of ProductsApproveRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
parApprovalURLInfo :: Lens' ProductsApproveRequest (Maybe ApprovalURLInfo) Source #
The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated.
CollectionViewersListResponse
data CollectionViewersListResponse Source #
The user resources for the collection.
See: collectionViewersListResponse
smart constructor.
collectionViewersListResponse :: CollectionViewersListResponse Source #
Creates a value of CollectionViewersListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cvlrKind :: Lens' CollectionViewersListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionViewersListResponse".
Entitlement
data Entitlement Source #
The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise. It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices. The API can be used to create an entitlement. If the app is a free app, a group license for that app is created. If it's a paid app, creating the entitlement consumes one license; it remains consumed until the entitlement is removed. Optionally an installation of the app on all the user's managed devices can be triggered at the time the entitlement is created. An entitlement cannot be created for an app if the app requires permissions that the enterprise has not yet accepted. Entitlements for paid apps that are due to purchases by the user on a non-managed profile will have "userPurchase" as entitlement reason; those entitlements cannot be removed via the API.
See: entitlement
smart constructor.
entitlement :: Entitlement Source #
Creates a value of Entitlement
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eeKind :: Lens' Entitlement Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
eeReason :: Lens' Entitlement (Maybe Text) Source #
The reason for the entitlement, e.g. "free" for free apps. This is temporary, it will be replaced by the acquisition kind field of group licenses.
eeProductId :: Lens' Entitlement (Maybe Text) Source #
The ID of the product that the entitlement is for, e.g. "app:com.google.android.gm".
ProductsListResponse
data ProductsListResponse Source #
The matching products.
See: productsListResponse
smart constructor.
productsListResponse :: ProductsListResponse Source #
Creates a value of ProductsListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
plrTokenPagination :: Lens' ProductsListResponse (Maybe TokenPagination) Source #
Pagination information for token pagination.
plrPageInfo :: Lens' ProductsListResponse (Maybe PageInfo) Source #
General pagination information.
plrKind :: Lens' ProductsListResponse Text Source #
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productsListResponse".
plrProduct :: Lens' ProductsListResponse [Product] Source #
Information about a product (e.g. an app) in the Google Play Store, for display to an enterprise admin.