Package software.xdev.brevo.api

Class MasterAccountApi

java.lang.Object
software.xdev.brevo.client.BaseApi
software.xdev.brevo.api.MasterAccountApi
public class MasterAccountApi extends BaseApi

  • Constructor Details

    • MasterAccountApi

      public MasterAccountApi()

    • MasterAccountApi

      public MasterAccountApi(ApiClient apiClient)

  • Method Details

    • corporateGroupIdDelete

      public void corporateGroupIdDelete(@Nonnull String id) throws ApiException
      Delete a group This endpoint allows you to delete a group of sub-organizations. When a group is deleted, the sub-organizations are no longer part of this group. The users associated with the group are no longer associated with the group once deleted.
      Parameters:
      id - Id of the group (required)
      Throws:
      ApiException - if fails to make API call

    • corporateGroupIdDelete

      public void corporateGroupIdDelete(@Nonnull String id, Map<String,String> additionalHeaders) throws ApiException
      Delete a group This endpoint allows you to delete a group of sub-organizations. When a group is deleted, the sub-organizations are no longer part of this group. The users associated with the group are no longer associated with the group once deleted.
      Parameters:
      id - Id of the group (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • corporateGroupIdGet

      public CorporateGroupDetailsResponse corporateGroupIdGet(@Nonnull String id) throws ApiException
      GET a group details This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.
      Parameters:
      id - Id of the group of sub-organization (required)
      Returns:
      CorporateGroupDetailsResponse
      Throws:
      ApiException - if fails to make API call

    • corporateGroupIdGet

      public CorporateGroupDetailsResponse corporateGroupIdGet(@Nonnull String id, Map<String,String> additionalHeaders) throws ApiException
      GET a group details This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.
      Parameters:
      id - Id of the group of sub-organization (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CorporateGroupDetailsResponse
      Throws:
      ApiException - if fails to make API call

    • corporateGroupIdPut

      public void corporateGroupIdPut(@Nonnull String id, @Nonnull CorporateGroupIdPutRequest corporateGroupIdPutRequest) throws ApiException
      Update a group of sub-accounts This endpoint allows to update a group of sub-accounts
      Parameters:
      id - Id of the group (required)
      corporateGroupIdPutRequest - Group details to be updated. (required)
      Throws:
      ApiException - if fails to make API call

    • corporateGroupIdPut

      public void corporateGroupIdPut(@Nonnull String id, @Nonnull CorporateGroupIdPutRequest corporateGroupIdPutRequest, Map<String,String> additionalHeaders) throws ApiException
      Update a group of sub-accounts This endpoint allows to update a group of sub-accounts
      Parameters:
      id - Id of the group (required)
      corporateGroupIdPutRequest - Group details to be updated. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • corporateGroupPost

      public CorporateGroupPost201Response corporateGroupPost(@Nullable CorporateGroupPostRequest corporateGroupPostRequest) throws ApiException
      Create a group of sub-accounts This endpoint allows to create a group of sub-accounts
      Parameters:
      corporateGroupPostRequest - (optional)
      Returns:
      CorporateGroupPost201Response
      Throws:
      ApiException - if fails to make API call

    • corporateGroupPost

      public CorporateGroupPost201Response corporateGroupPost(@Nullable CorporateGroupPostRequest corporateGroupPostRequest, Map<String,String> additionalHeaders) throws ApiException
      Create a group of sub-accounts This endpoint allows to create a group of sub-accounts
      Parameters:
      corporateGroupPostRequest - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CorporateGroupPost201Response
      Throws:
      ApiException - if fails to make API call

    • corporateGroupUnlinkGroupIdSubAccountsPut

      public void corporateGroupUnlinkGroupIdSubAccountsPut(@Nonnull String groupId, @Nonnull CorporateGroupUnlinkGroupIdSubAccountsPutRequest corporateGroupUnlinkGroupIdSubAccountsPutRequest) throws ApiException
      Delete sub-account from group This endpoint allows you to remove a sub-organization from a group.
      Parameters:
      groupId - Group id (required)
      corporateGroupUnlinkGroupIdSubAccountsPutRequest - List of sub-account ids (required)
      Throws:
      ApiException - if fails to make API call

    • corporateGroupUnlinkGroupIdSubAccountsPut

      public void corporateGroupUnlinkGroupIdSubAccountsPut(@Nonnull String groupId, @Nonnull CorporateGroupUnlinkGroupIdSubAccountsPutRequest corporateGroupUnlinkGroupIdSubAccountsPutRequest, Map<String,String> additionalHeaders) throws ApiException
      Delete sub-account from group This endpoint allows you to remove a sub-organization from a group.
      Parameters:
      groupId - Group id (required)
      corporateGroupUnlinkGroupIdSubAccountsPutRequest - List of sub-account ids (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • corporateIpGet

      public List<CorporateIpGet200ResponseInner> corporateIpGet() throws ApiException
      List of all IPs This endpoint allows you to retrieve the list of active IPs on your Admin account
      Returns:
      List<CorporateIpGet200ResponseInner>
      Throws:
      ApiException - if fails to make API call

    • corporateIpGet

      public List<CorporateIpGet200ResponseInner> corporateIpGet(Map<String,String> additionalHeaders) throws ApiException
      List of all IPs This endpoint allows you to retrieve the list of active IPs on your Admin account
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<CorporateIpGet200ResponseInner>
      Throws:
      ApiException - if fails to make API call

    • corporateMasterAccountGet

      public MasterDetailsResponse corporateMasterAccountGet() throws ApiException
      Get the details of requested master account This endpoint will provide the details of the master account.
      Returns:
      MasterDetailsResponse
      Throws:
      ApiException - if fails to make API call

    • corporateMasterAccountGet

      public MasterDetailsResponse corporateMasterAccountGet(Map<String,String> additionalHeaders) throws ApiException
      Get the details of requested master account This endpoint will provide the details of the master account.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      MasterDetailsResponse
      Throws:
      ApiException - if fails to make API call

    • corporateSsoTokenPost

      public GetSsoToken corporateSsoTokenPost(@Nullable CorporateSsoTokenPostRequest corporateSsoTokenPostRequest) throws ApiException
      Generate SSO token to access admin account This endpoint generates an SSO token to authenticate and access the admin account using the endpoint https://account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.
      Parameters:
      corporateSsoTokenPostRequest - (optional)
      Returns:
      GetSsoToken
      Throws:
      ApiException - if fails to make API call

    • corporateSsoTokenPost

      public GetSsoToken corporateSsoTokenPost(@Nullable CorporateSsoTokenPostRequest corporateSsoTokenPostRequest, Map<String,String> additionalHeaders) throws ApiException
      Generate SSO token to access admin account This endpoint generates an SSO token to authenticate and access the admin account using the endpoint https://account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.
      Parameters:
      corporateSsoTokenPostRequest - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetSsoToken
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountGet

      public SubAccountsResponse corporateSubAccountGet(@Nonnull Integer offset, @Nonnull Integer limit) throws ApiException
      Get the list of all the sub-accounts of the master account. This endpoint will provide the list all the sub-accounts of the master account.
      Parameters:
      offset - Index of the first sub-account in the page (required)
      limit - Number of sub-accounts to be displayed on each page (required)
      Returns:
      SubAccountsResponse
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountGet

      public SubAccountsResponse corporateSubAccountGet(@Nonnull Integer offset, @Nonnull Integer limit, Map<String,String> additionalHeaders) throws ApiException
      Get the list of all the sub-accounts of the master account. This endpoint will provide the list all the sub-accounts of the master account.
      Parameters:
      offset - Index of the first sub-account in the page (required)
      limit - Number of sub-accounts to be displayed on each page (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      SubAccountsResponse
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIdApplicationsTogglePut

      public void corporateSubAccountIdApplicationsTogglePut(@Nonnull Long id, @Nonnull SubAccountAppsToggleRequest subAccountAppsToggleRequest) throws ApiException
      Enable/disable sub-account application(s) API endpoints for the Corporate owner to enable/disable applications on the sub-account
      Parameters:
      id - Id of the sub-account organization (mandatory) (required)
      subAccountAppsToggleRequest - List of applications to activate or deactivate on a sub-account (required)
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIdApplicationsTogglePut

      public void corporateSubAccountIdApplicationsTogglePut(@Nonnull Long id, @Nonnull SubAccountAppsToggleRequest subAccountAppsToggleRequest, Map<String,String> additionalHeaders) throws ApiException
      Enable/disable sub-account application(s) API endpoints for the Corporate owner to enable/disable applications on the sub-account
      Parameters:
      id - Id of the sub-account organization (mandatory) (required)
      subAccountAppsToggleRequest - List of applications to activate or deactivate on a sub-account (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIdDelete

      public void corporateSubAccountIdDelete(@Nonnull Long id) throws ApiException
      Delete a sub-account
      Parameters:
      id - Id of the sub-account organization to be deleted (required)
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIdDelete

      public void corporateSubAccountIdDelete(@Nonnull Long id, Map<String,String> additionalHeaders) throws ApiException
      Delete a sub-account
      Parameters:
      id - Id of the sub-account organization to be deleted (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIdGet

      public SubAccountDetailsResponse corporateSubAccountIdGet(@Nonnull Long id) throws ApiException
      Get sub-account details This endpoint will provide the details for the specified sub-account company
      Parameters:
      id - Id of the sub-account organization (required)
      Returns:
      SubAccountDetailsResponse
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIdGet

      public SubAccountDetailsResponse corporateSubAccountIdGet(@Nonnull Long id, Map<String,String> additionalHeaders) throws ApiException
      Get sub-account details This endpoint will provide the details for the specified sub-account company
      Parameters:
      id - Id of the sub-account organization (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      SubAccountDetailsResponse
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIdPlanPut

      public void corporateSubAccountIdPlanPut(@Nonnull Long id, @Nonnull SubAccountUpdatePlanRequest subAccountUpdatePlanRequest) throws ApiException
      Update sub-account plan This endpoint will update the sub-account plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1\" to set the consumable in unlimited mode.
      Parameters:
      id - Id of the sub-account organization (required)
      subAccountUpdatePlanRequest - Values to update a sub-account plan (required)
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIdPlanPut

      public void corporateSubAccountIdPlanPut(@Nonnull Long id, @Nonnull SubAccountUpdatePlanRequest subAccountUpdatePlanRequest, Map<String,String> additionalHeaders) throws ApiException
      Update sub-account plan This endpoint will update the sub-account plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1\" to set the consumable in unlimited mode.
      Parameters:
      id - Id of the sub-account organization (required)
      subAccountUpdatePlanRequest - Values to update a sub-account plan (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIpAssociatePost

      public Object corporateSubAccountIpAssociatePost(@Nullable CorporateSubAccountIpAssociatePostRequest corporateSubAccountIpAssociatePostRequest) throws ApiException
      Associate an IP to sub-accounts This endpoint allows to associate an IP to sub-accounts
      Parameters:
      corporateSubAccountIpAssociatePostRequest - (optional)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIpAssociatePost

      public Object corporateSubAccountIpAssociatePost(@Nullable CorporateSubAccountIpAssociatePostRequest corporateSubAccountIpAssociatePostRequest, Map<String,String> additionalHeaders) throws ApiException
      Associate an IP to sub-accounts This endpoint allows to associate an IP to sub-accounts
      Parameters:
      corporateSubAccountIpAssociatePostRequest - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIpDissociatePut

      public void corporateSubAccountIpDissociatePut(@Nullable CorporateSubAccountIpDissociatePutRequest corporateSubAccountIpDissociatePutRequest) throws ApiException
      Dissociate an IP to sub-accounts This endpoint allows to dissociate an IP from sub-accounts
      Parameters:
      corporateSubAccountIpDissociatePutRequest - (optional)
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountIpDissociatePut

      public void corporateSubAccountIpDissociatePut(@Nullable CorporateSubAccountIpDissociatePutRequest corporateSubAccountIpDissociatePutRequest, Map<String,String> additionalHeaders) throws ApiException
      Dissociate an IP to sub-accounts This endpoint allows to dissociate an IP from sub-accounts
      Parameters:
      corporateSubAccountIpDissociatePutRequest - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountKeyPost

      public CreateApiKeyResponse corporateSubAccountKeyPost(@Nullable CorporateSubAccountKeyPostRequest corporateSubAccountKeyPostRequest) throws ApiException
      Create an API key for a sub-account This endpoint will generate an API v3 key for a sub account
      Parameters:
      corporateSubAccountKeyPostRequest - (optional)
      Returns:
      CreateApiKeyResponse
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountKeyPost

      public CreateApiKeyResponse corporateSubAccountKeyPost(@Nullable CorporateSubAccountKeyPostRequest corporateSubAccountKeyPostRequest, Map<String,String> additionalHeaders) throws ApiException
      Create an API key for a sub-account This endpoint will generate an API v3 key for a sub account
      Parameters:
      corporateSubAccountKeyPostRequest - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CreateApiKeyResponse
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountPost

      public CreateSubAccountResponse corporateSubAccountPost(@Nonnull CreateSubAccount createSubAccount) throws ApiException
      Create a new sub-account under a master account. This endpoint will create a new sub-account under a master account
      Parameters:
      createSubAccount - Request body with sub-account organization name (required)
      Returns:
      CreateSubAccountResponse
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountPost

      public CreateSubAccountResponse corporateSubAccountPost(@Nonnull CreateSubAccount createSubAccount, Map<String,String> additionalHeaders) throws ApiException
      Create a new sub-account under a master account. This endpoint will create a new sub-account under a master account
      Parameters:
      createSubAccount - Request body with sub-account organization name (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CreateSubAccountResponse
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountSsoTokenPost

      public GetSsoToken corporateSubAccountSsoTokenPost(@Nullable CorporateSubAccountSsoTokenPostRequest corporateSubAccountSsoTokenPostRequest) throws ApiException
      Generate SSO token to access sub-account This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
      Parameters:
      corporateSubAccountSsoTokenPostRequest - (optional)
      Returns:
      GetSsoToken
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountSsoTokenPost

      public GetSsoToken corporateSubAccountSsoTokenPost(@Nullable CorporateSubAccountSsoTokenPostRequest corporateSubAccountSsoTokenPostRequest, Map<String,String> additionalHeaders) throws ApiException
      Generate SSO token to access sub-account This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
      Parameters:
      corporateSubAccountSsoTokenPostRequest - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetSsoToken
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountsPlanPut

      public void corporateSubAccountsPlanPut(@Nonnull SubAccountsUpdatePlanRequest subAccountsUpdatePlanRequest) throws ApiException
      Update sub-accounts plan This endpoint will update multiple sub-accounts plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1\" to set the consumable in unlimited mode.
      Parameters:
      subAccountsUpdatePlanRequest - Values to update sub-accounts plan (required)
      Throws:
      ApiException - if fails to make API call

    • corporateSubAccountsPlanPut

      public void corporateSubAccountsPlanPut(@Nonnull SubAccountsUpdatePlanRequest subAccountsUpdatePlanRequest, Map<String,String> additionalHeaders) throws ApiException
      Update sub-accounts plan This endpoint will update multiple sub-accounts plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1\" to set the consumable in unlimited mode.
      Parameters:
      subAccountsUpdatePlanRequest - Values to update sub-accounts plan (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • corporateUserEmailPermissionsPut

      public void corporateUserEmailPermissionsPut(@Nonnull String email, @Nonnull CorporateUserEmailPermissionsPutRequest corporateUserEmailPermissionsPutRequest) throws ApiException
      Change admin user permissions This endpoint will allow you to change the permissions of Admin users of your Admin account
      Parameters:
      email - Email address of Admin user (required)
      corporateUserEmailPermissionsPutRequest - Values to update an admin user permissions (required)
      Throws:
      ApiException - if fails to make API call

    • corporateUserEmailPermissionsPut

      public void corporateUserEmailPermissionsPut(@Nonnull String email, @Nonnull CorporateUserEmailPermissionsPutRequest corporateUserEmailPermissionsPutRequest, Map<String,String> additionalHeaders) throws ApiException
      Change admin user permissions This endpoint will allow you to change the permissions of Admin users of your Admin account
      Parameters:
      email - Email address of Admin user (required)
      corporateUserEmailPermissionsPutRequest - Values to update an admin user permissions (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • corporateUserInvitationActionEmailPut

      public CorporateUserInvitationActionEmailPut200Response corporateUserInvitationActionEmailPut(@Nonnull String action, @Nonnull String email) throws ApiException
      Resend / cancel admin user invitation This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation
      Parameters:
      action - Action to be performed (cancel / resend) (required)
      email - Email address of the recipient (required)
      Returns:
      CorporateUserInvitationActionEmailPut200Response
      Throws:
      ApiException - if fails to make API call

    • corporateUserInvitationActionEmailPut

      public CorporateUserInvitationActionEmailPut200Response corporateUserInvitationActionEmailPut(@Nonnull String action, @Nonnull String email, Map<String,String> additionalHeaders) throws ApiException
      Resend / cancel admin user invitation This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation
      Parameters:
      action - Action to be performed (cancel / resend) (required)
      email - Email address of the recipient (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CorporateUserInvitationActionEmailPut200Response
      Throws:
      ApiException - if fails to make API call

    • corporateUserRevokeEmailDelete

      public void corporateUserRevokeEmailDelete(@Nonnull String email) throws ApiException
      Revoke an admin user This endpoint allows to revoke/remove an invited member of your Admin account
      Parameters:
      email - Email of the invited user (required)
      Throws:
      ApiException - if fails to make API call

    • corporateUserRevokeEmailDelete

      public void corporateUserRevokeEmailDelete(@Nonnull String email, Map<String,String> additionalHeaders) throws ApiException
      Revoke an admin user This endpoint allows to revoke/remove an invited member of your Admin account
      Parameters:
      email - Email of the invited user (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getAccountActivity

      public GetAccountActivity getAccountActivity(@Nullable String startDate, @Nullable String endDate, @Nullable String email, @Nullable Long limit, @Nullable Long offset) throws ApiException
      Get user activity logs
      Parameters:
      startDate - Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional)
      endDate - Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional)
      email - Enter the user's email address to filter their activity in the account. (optional)
      limit - Number of documents per page (optional, default to 10)
      offset - Index of the first document in the page. (optional, default to 0)
      Returns:
      GetAccountActivity
      Throws:
      ApiException - if fails to make API call

    • getAccountActivity

      public GetAccountActivity getAccountActivity(@Nullable String startDate, @Nullable String endDate, @Nullable String email, @Nullable Long limit, @Nullable Long offset, Map<String,String> additionalHeaders) throws ApiException
      Get user activity logs
      Parameters:
      startDate - Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional)
      endDate - Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional)
      email - Enter the user's email address to filter their activity in the account. (optional)
      limit - Number of documents per page (optional, default to 10)
      offset - Index of the first document in the page. (optional, default to 0)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetAccountActivity
      Throws:
      ApiException - if fails to make API call

    • getCorporateInvitedUsersList

      public GetCorporateInvitedUsersList getCorporateInvitedUsersList() throws ApiException
      Get the list of all admin users This endpoint allows you to list all Admin users of your Admin account
      Returns:
      GetCorporateInvitedUsersList
      Throws:
      ApiException - if fails to make API call

    • getCorporateInvitedUsersList

      public GetCorporateInvitedUsersList getCorporateInvitedUsersList(Map<String,String> additionalHeaders) throws ApiException
      Get the list of all admin users This endpoint allows you to list all Admin users of your Admin account
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetCorporateInvitedUsersList
      Throws:
      ApiException - if fails to make API call

    • getCorporateUserPermission

      public GetCorporateUserPermission getCorporateUserPermission(@Nonnull String email) throws ApiException
      Check admin user permissions This endpoint will provide the list of admin user permissions
      Parameters:
      email - Email of the invited user. (required)
      Returns:
      GetCorporateUserPermission
      Throws:
      ApiException - if fails to make API call

    • getCorporateUserPermission

      public GetCorporateUserPermission getCorporateUserPermission(@Nonnull String email, Map<String,String> additionalHeaders) throws ApiException
      Check admin user permissions This endpoint will provide the list of admin user permissions
      Parameters:
      email - Email of the invited user. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetCorporateUserPermission
      Throws:
      ApiException - if fails to make API call

    • getSubAccountGroups

      public List<GetSubAccountGroups200ResponseInner> getSubAccountGroups() throws ApiException
      Get the list of groups This endpoint allows you to list all groups created on your Admin account.
      Returns:
      List<GetSubAccountGroups200ResponseInner>
      Throws:
      ApiException - if fails to make API call

    • getSubAccountGroups

      public List<GetSubAccountGroups200ResponseInner> getSubAccountGroups(Map<String,String> additionalHeaders) throws ApiException
      Get the list of groups This endpoint allows you to list all groups created on your Admin account.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<GetSubAccountGroups200ResponseInner>
      Throws:
      ApiException - if fails to make API call

    • inviteAdminUser

      public CorporateGroupPost201Response inviteAdminUser(@Nonnull InviteAdminUser inviteAdminUser) throws ApiException
      Send invitation to an admin user `This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - \"all\" - `api`: - \"none\" - `user_management`: - \"all\" - `app_management` | Not available in ENTv2: - \"all\" - `sub_organization_groups` - \"create\" - \"edit_delete\" - `create_sub_organizations` - \"all\" - `manage_sub_organizations` - \"all\" - `analytics` - \"download_data\" - \"create_alerts\" - \"my_looks\" - \"explore_create\" - `security` - \"all\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited admin user.
      Parameters:
      inviteAdminUser - Payload to send an invitation (required)
      Returns:
      CorporateGroupPost201Response
      Throws:
      ApiException - if fails to make API call

    • inviteAdminUser

      public CorporateGroupPost201Response inviteAdminUser(@Nonnull InviteAdminUser inviteAdminUser, Map<String,String> additionalHeaders) throws ApiException
      Send invitation to an admin user `This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - \"all\" - `api`: - \"none\" - `user_management`: - \"all\" - `app_management` | Not available in ENTv2: - \"all\" - `sub_organization_groups` - \"create\" - \"edit_delete\" - `create_sub_organizations` - \"all\" - `manage_sub_organizations` - \"all\" - `analytics` - \"download_data\" - \"create_alerts\" - \"my_looks\" - \"explore_create\" - `security` - \"all\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it's assumed that all permissions will be there for the invited admin user.
      Parameters:
      inviteAdminUser - Payload to send an invitation (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CorporateGroupPost201Response
      Throws:
      ApiException - if fails to make API call

    • invokeAPI

      public <T> T invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders) throws ApiException
      Description copied from class: BaseApi
      Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.
      Specified by:
      invokeAPI in class BaseApi
      Parameters:
      url - The URL for the request, either full URL or only the path.
      method - The HTTP method for the request.
      request - The request object.
      returnType - The return type.
      additionalHeaders - Additional headers for the request.
      Returns:
      The API response in the specified type.
      Throws:
      ApiException - if fails to make API call.