Package odata.msgraph.client.beta.entity

Class VppToken

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType
    public class VppToken
extends Entity
implements com.github.davidmoten.odata.client.ODataEntityType
    “You purchase multiple licenses for iOS apps through the Apple Volume Purchase Program for Business or Education. This involves setting up an Apple VPP account from the Apple website and uploading the Apple VPP Business or Education token to Intune. You can then synchronize your volume purchase information with Intune and track your volume-purchased app use. You can upload multiple Apple VPP Business or Education tokens.”

    • Field Detail

      • appleId

        protected String appleId

      • automaticallyUpdateApps

        protected Boolean automaticallyUpdateApps

      • claimTokenManagementFromExternalMdm

        protected Boolean claimTokenManagementFromExternalMdm

      • countryOrRegion

        protected String countryOrRegion

      • dataSharingConsentGranted

        protected Boolean dataSharingConsentGranted

      • displayName

        protected String displayName

      • locationName

        protected String locationName

      • organizationName

        protected String organizationName

      • roleScopeTagIds

        protected List<String> roleScopeTagIds

      • roleScopeTagIdsNextLink

        protected String roleScopeTagIdsNextLink

      • token

        protected String token

      • tokenActionResultsNextLink

        protected String tokenActionResultsNextLink

    • Constructor Detail

      • VppToken

        protected VppToken()

    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        odataTypeName in class Entity

      • builderVppToken

        public static VppToken.Builder builderVppToken()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class

      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class Entity

      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class Entity

      • getAppleId

        public Optional<String> getAppleId()
        “The apple Id associated with the given Apple Volume Purchase Program Token.”
        Returns:
        property appleId

      • withAppleId

        public VppToken withAppleId​(String appleId)
        Returns an immutable copy of this with just the appleId field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The apple Id associated with the given Apple Volume Purchase Program Token.”

        Parameters:
        appleId - new value of appleId field (as defined in service metadata)
        Returns:
        immutable copy of this with just the appleId field changed

      • getAutomaticallyUpdateApps

        public Optional<Boolean> getAutomaticallyUpdateApps()
        “Whether or not apps for the VPP token will be automatically updated.”
        Returns:
        property automaticallyUpdateApps

      • withAutomaticallyUpdateApps

        public VppToken withAutomaticallyUpdateApps​(Boolean automaticallyUpdateApps)
        Returns an immutable copy of this with just the automaticallyUpdateApps field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Whether or not apps for the VPP token will be automatically updated.”

        Parameters:
        automaticallyUpdateApps - new value of automaticallyUpdateApps field (as defined in service metadata)
        Returns:
        immutable copy of this with just the automaticallyUpdateApps field changed

      • getClaimTokenManagementFromExternalMdm

        public Optional<Boolean> getClaimTokenManagementFromExternalMdm()
        “Admin consent to allow claiming token management from external MDM.”
        Returns:
        property claimTokenManagementFromExternalMdm

      • withClaimTokenManagementFromExternalMdm

        public VppToken withClaimTokenManagementFromExternalMdm​(Boolean claimTokenManagementFromExternalMdm)
        Returns an immutable copy of this with just the claimTokenManagementFromExternalMdm field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Admin consent to allow claiming token management from external MDM.”

        Parameters:
        claimTokenManagementFromExternalMdm - new value of claimTokenManagementFromExternalMdm field (as defined in service metadata)
        Returns:
        immutable copy of this with just the claimTokenManagementFromExternalMdm field changed

      • getCountryOrRegion

        public Optional<String> getCountryOrRegion()
        “Whether or not apps for the VPP token will be automatically updated.”
        Returns:
        property countryOrRegion

      • withCountryOrRegion

        public VppToken withCountryOrRegion​(String countryOrRegion)
        Returns an immutable copy of this with just the countryOrRegion field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Whether or not apps for the VPP token will be automatically updated.”

        Parameters:
        countryOrRegion - new value of countryOrRegion field (as defined in service metadata)
        Returns:
        immutable copy of this with just the countryOrRegion field changed

      • getDataSharingConsentGranted

        public Optional<Boolean> getDataSharingConsentGranted()
        “Consent granted for data sharing with the Apple Volume Purchase Program.”
        Returns:
        property dataSharingConsentGranted

      • withDataSharingConsentGranted

        public VppToken withDataSharingConsentGranted​(Boolean dataSharingConsentGranted)
        Returns an immutable copy of this with just the dataSharingConsentGranted field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Consent granted for data sharing with the Apple Volume Purchase Program.”

        Parameters:
        dataSharingConsentGranted - new value of dataSharingConsentGranted field (as defined in service metadata)
        Returns:
        immutable copy of this with just the dataSharingConsentGranted field changed

      • getDisplayName

        public Optional<String> getDisplayName()
        “An admin specified token friendly name.”
        Returns:
        property displayName

      • withDisplayName

        public VppToken withDisplayName​(String displayName)
        Returns an immutable copy of this with just the displayName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “An admin specified token friendly name.”

        Parameters:
        displayName - new value of displayName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the displayName field changed

      • getExpirationDateTime

        public Optional<OffsetDateTime> getExpirationDateTime()
        “The expiration date time of the Apple Volume Purchase Program Token.”
        Returns:
        property expirationDateTime

      • withExpirationDateTime

        public VppToken withExpirationDateTime​(OffsetDateTime expirationDateTime)
        Returns an immutable copy of this with just the expirationDateTime field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The expiration date time of the Apple Volume Purchase Program Token.”

        Parameters:
        expirationDateTime - new value of expirationDateTime field (as defined in service metadata)
        Returns:
        immutable copy of this with just the expirationDateTime field changed

      • getLastModifiedDateTime

        public Optional<OffsetDateTime> getLastModifiedDateTime()
        “Last modification date time associated with the Apple Volume Purchase Program Token.”
        Returns:
        property lastModifiedDateTime

      • withLastModifiedDateTime

        public VppToken withLastModifiedDateTime​(OffsetDateTime lastModifiedDateTime)
        Returns an immutable copy of this with just the lastModifiedDateTime field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Last modification date time associated with the Apple Volume Purchase Program Token.”

        Parameters:
        lastModifiedDateTime - new value of lastModifiedDateTime field (as defined in service metadata)
        Returns:
        immutable copy of this with just the lastModifiedDateTime field changed

      • getLastSyncDateTime

        public Optional<OffsetDateTime> getLastSyncDateTime()
        “The last time when an application sync was done with the Apple volume purchase program service using the the Apple Volume Purchase Program Token.”
        Returns:
        property lastSyncDateTime

      • withLastSyncDateTime

        public VppToken withLastSyncDateTime​(OffsetDateTime lastSyncDateTime)
        Returns an immutable copy of this with just the lastSyncDateTime field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The last time when an application sync was done with the Apple volume purchase program service using the the Apple Volume Purchase Program Token.”

        Parameters:
        lastSyncDateTime - new value of lastSyncDateTime field (as defined in service metadata)
        Returns:
        immutable copy of this with just the lastSyncDateTime field changed

      • getLastSyncStatus

        public Optional<VppTokenSyncStatus> getLastSyncStatus()
        “Current sync status of the last application sync which was triggered using the Apple Volume Purchase Program Token. Possible values are: `none`, `inProgress`, `completed`, `failed`.”
        Returns:
        property lastSyncStatus

      • withLastSyncStatus

        public VppToken withLastSyncStatus​(VppTokenSyncStatus lastSyncStatus)
        Returns an immutable copy of this with just the lastSyncStatus field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Current sync status of the last application sync which was triggered using the Apple Volume Purchase Program Token. Possible values are: `none`, `inProgress`, `completed`, `failed`.”

        Parameters:
        lastSyncStatus - new value of lastSyncStatus field (as defined in service metadata)
        Returns:
        immutable copy of this with just the lastSyncStatus field changed

      • getLocationName

        public Optional<String> getLocationName()
        “Token location returned from Apple VPP.”
        Returns:
        property locationName

      • withLocationName

        public VppToken withLocationName​(String locationName)
        Returns an immutable copy of this with just the locationName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Token location returned from Apple VPP.”

        Parameters:
        locationName - new value of locationName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the locationName field changed

      • getOrganizationName

        public Optional<String> getOrganizationName()
        “The organization associated with the Apple Volume Purchase Program Token”
        Returns:
        property organizationName

      • withOrganizationName

        public VppToken withOrganizationName​(String organizationName)
        Returns an immutable copy of this with just the organizationName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The organization associated with the Apple Volume Purchase Program Token”

        Parameters:
        organizationName - new value of organizationName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the organizationName field changed

      • getRoleScopeTagIds

        public com.github.davidmoten.odata.client.CollectionPage<String> getRoleScopeTagIds()
        “Role Scope Tags IDs assigned to this entity.”
        Returns:
        property roleScopeTagIds

      • withRoleScopeTagIds

        public VppToken withRoleScopeTagIds​(List<String> roleScopeTagIds)
        Returns an immutable copy of this with just the roleScopeTagIds field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Role Scope Tags IDs assigned to this entity.”

        Parameters:
        roleScopeTagIds - new value of roleScopeTagIds field (as defined in service metadata)
        Returns:
        immutable copy of this with just the roleScopeTagIds field changed

      • getRoleScopeTagIds

        public com.github.davidmoten.odata.client.CollectionPage<String> getRoleScopeTagIds​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Role Scope Tags IDs assigned to this entity.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property roleScopeTagIds

      • getState

        public Optional<VppTokenState> getState()
        “Current state of the Apple Volume Purchase Program Token. Possible values are: ` unknown`, `valid`, `expired`, `invalid`, `assignedToExternalMDM`.”
        Returns:
        property state

      • withState

        public VppToken withState​(VppTokenState state)
        Returns an immutable copy of this with just the state field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Current state of the Apple Volume Purchase Program Token. Possible values are: ` unknown`, `valid`, `expired`, `invalid`, `assignedToExternalMDM`.”

        Parameters:
        state - new value of state field (as defined in service metadata)
        Returns:
        immutable copy of this with just the state field changed

      • getToken

        public Optional<String> getToken()
        “The Apple Volume Purchase Program Token string downloaded from the Apple Volume Purchase Program.”
        Returns:
        property token

      • withToken

        public VppToken withToken​(String token)
        Returns an immutable copy of this with just the token field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The Apple Volume Purchase Program Token string downloaded from the Apple Volume Purchase Program.”

        Parameters:
        token - new value of token field (as defined in service metadata)
        Returns:
        immutable copy of this with just the token field changed

      • getTokenActionResults

        public com.github.davidmoten.odata.client.CollectionPage<VppTokenActionResult> getTokenActionResults()
        “The collection of statuses of the actions performed on the Apple Volume Purchase Program Token.”
        Returns:
        property tokenActionResults

      • withTokenActionResults

        public VppToken withTokenActionResults​(List<VppTokenActionResult> tokenActionResults)
        Returns an immutable copy of this with just the tokenActionResults field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The collection of statuses of the actions performed on the Apple Volume Purchase Program Token.”

        Parameters:
        tokenActionResults - new value of tokenActionResults field (as defined in service metadata)
        Returns:
        immutable copy of this with just the tokenActionResults field changed

      • getTokenActionResults

        public com.github.davidmoten.odata.client.CollectionPage<VppTokenActionResult> getTokenActionResults​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “The collection of statuses of the actions performed on the Apple Volume Purchase Program Token.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property tokenActionResults

      • getVppTokenAccountType

        public Optional<VppTokenAccountType> getVppTokenAccountType()
        “The type of volume purchase program which the given Apple Volume Purchase Program Token is associated with. Possible values are: `business`, `education`.”
        Returns:
        property vppTokenAccountType

      • withVppTokenAccountType

        public VppToken withVppTokenAccountType​(VppTokenAccountType vppTokenAccountType)
        Returns an immutable copy of this with just the vppTokenAccountType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The type of volume purchase program which the given Apple Volume Purchase Program Token is associated with. Possible values are: `business`, `education`.”

        Parameters:
        vppTokenAccountType - new value of vppTokenAccountType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the vppTokenAccountType field changed

      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class Entity

      • patch

        public VppToken patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected

      • put

        public VppToken put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected

      • revokeLicenses

        public com.github.davidmoten.odata.client.ActionRequestNoReturn revokeLicenses​(Boolean notifyManagedDevices,
                                                                               Boolean revokeUntrackedLicenses)

      • syncLicenses

        public com.github.davidmoten.odata.client.ActionRequestReturningNonCollectionUnwrapped<VppToken> syncLicenses()