Package com.broadleafcommerce.customer.web.endpoint

Class AccountInviteEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.AccountInviteEndpoint

@FrameworkRestController
@FrameworkMapping
@DataRouteByExample(Account.class)
public class AccountInviteEndpoint
extends Object

Constructor Summary

Constructors

Constructor	Description
AccountInviteEndpoint(AccountInviteService<AccountInvite> accountInviteService)

Method Summary

Modifier and Type	Method	Description
AccountMember	acceptInvite(String accountId, String inviteId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected AccountInviteService<AccountInvite>	getAccountInviteService()
org.springframework.http.ResponseEntity<AccountInvite>	inviteAccountMember(String accountId, AccountInviteRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<AccountInvite>	readAllInvites(cz.jirutka.rsql.parser.ast.Node filters, String accountId, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<AccountInvite>	readMyAccountInvites(org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Read the logged in user's account invites.
AccountInvite	resendInvite(String accountId, String inviteId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	revokeInvite(String accountId, String inviteId, String accountMemberId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountInviteEndpoint

public AccountInviteEndpoint(AccountInviteService<AccountInvite> accountInviteService)

Method Detail

readAllInvites

@Policy(permissionRoots="ACCOUNT_INVITE")
@FrameworkGetMapping("/accounts/{accountId}/account-invites")
public org.springframework.data.domain.Page<AccountInvite> readAllInvites(cz.jirutka.rsql.parser.ast.Node filters,
                                                                          @PathVariable
                                                                          String accountId,
                                                                          @PageableDefault(size=20)
                                                                          org.springframework.data.domain.Pageable page,
                                                                          @ContextOperation
                                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

inviteAccountMember

@Policy(permissionRoots="ACCOUNT_INVITE")
@FrameworkPostMapping("/accounts/{accountId}/account-invites")
public org.springframework.http.ResponseEntity<AccountInvite> inviteAccountMember(@PathVariable
                                                                                  String accountId,
                                                                                  @RequestBody
                                                                                  AccountInviteRequest request,
                                                                                  @ContextOperation(CREATE)
                                                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

revokeInvite

@Policy(permissionRoots="ACCOUNT_INVITE")
@FrameworkDeleteMapping("/accounts/{accountId}/account-invites/{inviteId}")
public void revokeInvite(@PathVariable
                         String accountId,
                         @PathVariable
                         String inviteId,
                         @RequestParam
                         String accountMemberId,
                         @ContextOperation(DELETE)
                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resendInvite

@Policy(permissionRoots="ACCOUNT_INVITE")
@FrameworkPostMapping("/accounts/{accountId}/account-invites/{inviteId}/resend-invite")
public AccountInvite resendInvite(@PathVariable
                                  String accountId,
                                  @PathVariable
                                  String inviteId,
                                  @ContextOperation(UPDATE)
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

acceptInvite

@Policy(permissionRoots={"CUSTOMER","CUSTOMER_PROFILE"})
@FrameworkPostMapping("/accounts/{accountId}/account-invites/{inviteId}/accept-invite")
public AccountMember acceptInvite(@PathVariable
                                  String accountId,
                                  @PathVariable
                                  String inviteId,
                                  @ContextOperation(UPDATE)
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readMyAccountInvites

@Policy(permissionRoots={"CUSTOMER","CUSTOMER_PROFILE"})
@FrameworkGetMapping("/accounts/my-account-invites")
public org.springframework.data.domain.Page<AccountInvite> readMyAccountInvites(@PageableDefault(50)
                                                                                org.springframework.data.domain.Pageable page,
                                                                                @ContextOperation
                                                                                com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Read the logged in user's account invites.

Returns:

Any account invites the user currently has

getAccountInviteService

protected AccountInviteService<AccountInvite> getAccountInviteService()