Spotify

9. USER ACCOUNT MODULE (UI prompt)

Module Entities (11)

Entity	Alias	Module	Global Schema
(1) Campaign	*Campaign*	UserAccountModule	Spotify
(2) CampaignType	*CampaignType*	UserAccountModule	Spotify
(3) Country	*Country*	CountryModule	Spotify
(4) CreatorToolUsage	*CreatorToolUsage*	TrackModule	Spotify
(5) Device	*Device*	DeviceModule	Spotify
(6) Region	*Region*	UserAccountModule	Spotify
(7) StreamEvent	*StreamEvent*	TrackModule	Spotify
(8) SubscriptionPlan	*SubscriptionPlan*	SubscriptionPlanModule	Spotify
(9) UserAccount	*UserAccount*	UserAccountModule	Spotify
(10) UserCampaignStat	*UserCampaignStat*	UserAccountModule	Spotify
(11) UserSubscription	*UserSubscription*	UserAccountModule	Spotify

Module Interfaces (37)

Remote Method	Local Method	Module	HTTP-Method	References
(1) /region	*findAllRegion()*	UserAccountModule	*GET*	Region
(2) /region	*insertRegion(region)*	UserAccountModule	*POST*	Region
(3) /usersubscription	*insertUserSubscription(usersubscription)*	UserAccountModule	*POST*	UserSubscription
(4) /region/{id}	*updateRegionById(region)*	UserAccountModule	*PUT*	Region
(5) /campaigntype/{id}	*findCampaignTypeById(id)*	UserAccountModule	*GET*	CampaignType
(6) /campaign/campaigntype/{id}	*findAllCampaignOfCampaignType(id)*	UserAccountModule	*GET*	CampaignType Campaign
(7) /usercampaignstat/{id}	*updateUserCampaignStatById(usercampaignstat)*	UserAccountModule	*PUT*	UserCampaignStat
(8) /useraccount	*findAllUserAccount()*	UserAccountModule	*GET*	UserAccount
(9) /campaign/{id}	*updateCampaignById(campaign)*	UserAccountModule	*PUT*	Campaign
(10) /usersubscription/{id}	*deleteUserSubscriptionById(id)*	UserAccountModule	*DELETE*	UserSubscription
(11) /usersubscription/{id}	*updateUserSubscriptionById(usersubscription)*	UserAccountModule	*PUT*	UserSubscription
(12) /campaigntype/{id}	*updateCampaignTypeById(campaigntype)*	UserAccountModule	*PUT*	CampaignType
(13) /usersubscription	*findAllUserSubscription()*	UserAccountModule	*GET*	UserSubscription
(14) /usercampaignstat/{id}	*deleteUserCampaignStatById(id)*	UserAccountModule	*DELETE*	UserCampaignStat
(15) /campaigntype	*findAllCampaignType()*	UserAccountModule	*GET*	CampaignType
(16) /campaigntype	*insertCampaignType(campaigntype)*	UserAccountModule	*POST*	CampaignType
(17) /campaign/{id}	*findCampaignById(id)*	UserAccountModule	*GET*	Campaign
(18) /useraccount/{id}	*updateUserAccountById(useraccount)*	UserAccountModule	*PUT*	UserAccount
(19) /useraccount	*insertUserAccount(useraccount)*	UserAccountModule	*POST*	UserAccount
(20) /usersubscription/{id}	*findUserSubscriptionById(id)*	UserAccountModule	*GET*	UserSubscription
(21) /campaign/{id}	*deleteCampaignById(id)*	UserAccountModule	*DELETE*	Campaign
(22) /usercampaignstat	*findAllUserCampaignStat()*	UserAccountModule	*GET*	UserCampaignStat
(23) /usercampaignstat/campaign/{id}	*findAllUserCampaignStatOfCampaign(id)*	UserAccountModule	*GET*	Campaign UserCampaignStat
(24) /useraccount/region/{id}	*findAllUserAccountOfRegion(id)*	UserAccountModule	*GET*	Region UserAccount
(25) /usercampaignstat	*insertUserCampaignStat(usercampaignstat)*	UserAccountModule	*POST*	UserCampaignStat
(26) /useraccount/{id}	*findUserAccountById(id)*	UserAccountModule	*GET*	UserAccount
(27) /campaign	*insertCampaign(campaign)*	UserAccountModule	*POST*	Campaign
(28) /useraccount/country/{id}	*findAllUserAccountOfCountry(id)*	UserAccountModule	*GET*	Country UserAccount
(29) /region/{id}	*deleteRegionById(id)*	UserAccountModule	*DELETE*	Region
(30) /region/{id}	*findRegionById(id)*	UserAccountModule	*GET*	Region
(31) /usersubscription/subscriptionplan/{id}	*findAllUserSubscriptionOfSubscriptionPlan(id)*	UserAccountModule	*GET*	SubscriptionPlan UserSubscription
(32) /usersubscription/useraccount/{id}	*findAllUserSubscriptionOfUserAccount(id)*	UserAccountModule	*GET*	UserAccount UserSubscription
(33) /useraccount/{id}	*deleteUserAccountById(id)*	UserAccountModule	*DELETE*	UserAccount
(34) /usercampaignstat/{id}	*findUserCampaignStatById(id)*	UserAccountModule	*GET*	UserCampaignStat
(35) /campaign	*findAllCampaign()*	UserAccountModule	*GET*	Campaign
(36) /campaigntype/{id}	*deleteCampaignTypeById(id)*	UserAccountModule	*DELETE*	CampaignType
(37) /usercampaignstat/useraccount/{id}	*findAllUserCampaignStatOfUserAccount(id)*	UserAccountModule	*GET*	UserAccount UserCampaignStat

9.1 CAMPAIGN

Campaign

UserAccountModule

Spotify

Properties (5)

Property	Type	Entity	Reference	Module
*(1) CampaignType*	*LONG*	Campaign	CampaignType	UserAccountModule
*(2) IsGlobal*	*BOOL*	Campaign
*(3) Name*	*STRING*	Campaign
*(4) PeriodEnd*	*DATE*	Campaign
*(5) PeriodStart*	*DATE*	Campaign

Example:

final Campaign campaign = (Campaign) invokeModule(USER_ACCOUNT_MODULE + "/campaign/" + id, Campaign.class);
if (campaign != null) {
    final CampaignType campaigntype1 = (CampaignType) invokeModule(USER_ACCOUNT_MODULE + "/campaigntype/" + campaign.getCampaignType().getId(), CampaignType.class);
    if (campaigntype1 != null) {
    }
}
return campaign;

9.2 CAMPAIGN TYPE

CampaignType

UserAccountModule

Spotify

Properties (2)

Property	Type	Entity	Reference	Module
*(1) Description*	*STRING*	CampaignType
*(2) Name*	*STRING*	CampaignType

Example:

final CampaignType campaigntype = (CampaignType) invokeModule(USER_ACCOUNT_MODULE + "/campaigntype/" + id, CampaignType.class);
if (campaigntype != null) {
}
return campaigntype;

9.3 REGION

Region

UserAccountModule

Spotify

Properties (2)

Property	Type	Entity	Reference	Module
*(1) Description*	*STRING*	Region
*(2) Name*	*STRING*	Region

Example:

final Region region = (Region) invokeModule(USER_ACCOUNT_MODULE + "/region/" + id, Region.class);
if (region != null) {
}
return region;

9.4 USER ACCOUNT

UserAccount

UserAccountModule

Spotify

Properties (9)

Property	Type	Entity	Reference	Module
*(1) BirthDate*	*DATE*	UserAccount
*(2) Country*	*LONG*	UserAccount	Country	CountryModule
*(3) CreatedAt*	*DATE*	UserAccount
*(4) DisplayName*	*STRING*	UserAccount
*(5) Email*	*STRING*	UserAccount
*(6) IsFamilyManager*	*BOOL*	UserAccount
*(7) IsPremium*	*BOOL*	UserAccount
*(8) IsStudent*	*BOOL*	UserAccount
*(9) Region*	*LONG*	UserAccount	Region	UserAccountModule

Example:

final UserAccount useraccount = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + id, UserAccount.class);
if (useraccount != null) {
    final Region region1 = (Region) invokeModule(USER_ACCOUNT_MODULE + "/region/" + useraccount.getRegion().getId(), Region.class);
    if (region1 != null) {
    }
    final Country country2 = (Country) invokeModule(COUNTRY_MODULE + "/country/" + useraccount.getCountry().getId(), Country.class);
    if (country2 != null) {
    }
}
return useraccount;

9.5 USER CAMPAIGN STAT

UserCampaignStat

UserAccountModule

Spotify

Properties (6)

Property	Type	Entity	Reference	Module
*(1) Campaign*	*LONG*	UserCampaignStat	Campaign	UserAccountModule
*(2) GeneratedAt*	*DATE*	UserCampaignStat
*(3) TopArtist*	*LONG*	UserCampaignStat
*(4) TopTrack*	*LONG*	UserCampaignStat
*(5) TotalMinutes*	*LONG*	UserCampaignStat
*(6) UserAccount*	*LONG*	UserCampaignStat	UserAccount	UserAccountModule

Example:

final UserCampaignStat usercampaignstat = (UserCampaignStat) invokeModule(USER_ACCOUNT_MODULE + "/usercampaignstat/" + id, UserCampaignStat.class);
if (usercampaignstat != null) {
    final Campaign campaign1 = (Campaign) invokeModule(USER_ACCOUNT_MODULE + "/campaign/" + usercampaignstat.getCampaign().getId(), Campaign.class);
    if (campaign1 != null) {
        final CampaignType campaigntype2 = (CampaignType) invokeModule(USER_ACCOUNT_MODULE + "/campaigntype/" + campaign1.getCampaignType().getId(), CampaignType.class);
        if (campaigntype2 != null) {
        }
    }
    final UserAccount useraccount3 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + usercampaignstat.getUserAccount().getId(), UserAccount.class);
    if (useraccount3 != null) {
        final Region region4 = (Region) invokeModule(USER_ACCOUNT_MODULE + "/region/" + useraccount3.getRegion().getId(), Region.class);
        if (region4 != null) {
        }
        final Country country5 = (Country) invokeModule(COUNTRY_MODULE + "/country/" + useraccount3.getCountry().getId(), Country.class);
        if (country5 != null) {
        }
    }
}
return usercampaignstat;

9.6 USER SUBSCRIPTION

UserSubscription

UserAccountModule

Spotify

Properties (7)

Property	Type	Entity	Reference	Module
*(1) EndedAt*	*DATE*	UserSubscription
*(2) HouseholdAddress*	*STRING*	UserSubscription
*(3) IsAutoRenew*	*BOOL*	UserSubscription
*(4) IsPrimaryHolder*	*BOOL*	UserSubscription
*(5) StartedAt*	*DATE*	UserSubscription
*(6) SubscriptionPlan*	*LONG*	UserSubscription	SubscriptionPlan	SubscriptionPlanModule
*(7) UserAccount*	*LONG*	UserSubscription	UserAccount	UserAccountModule

Example:

final UserSubscription usersubscription = (UserSubscription) invokeModule(USER_ACCOUNT_MODULE + "/usersubscription/" + id, UserSubscription.class);
if (usersubscription != null) {
    final SubscriptionPlan subscriptionplan1 = (SubscriptionPlan) invokeModule(SUBSCRIPTION_PLAN_MODULE + "/subscriptionplan/" + usersubscription.getSubscriptionPlan().getId(), SubscriptionPlan.class);
    if (subscriptionplan1 != null) {
    }
    final UserAccount useraccount2 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + usersubscription.getUserAccount().getId(), UserAccount.class);
    if (useraccount2 != null) {
        final Region region3 = (Region) invokeModule(USER_ACCOUNT_MODULE + "/region/" + useraccount2.getRegion().getId(), Region.class);
        if (region3 != null) {
        }
        final Country country4 = (Country) invokeModule(COUNTRY_MODULE + "/country/" + useraccount2.getCountry().getId(), Country.class);
        if (country4 != null) {
        }
    }
}
return usersubscription;