Package software.xdev.brevo.api

Class UserApi

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

  • Constructor Details

    • UserApi

      public UserApi()

    • UserApi

      public UserApi(ApiClient apiClient)

  • Method Details

    • editUserPermission

      public UpdateUserResponse editUserPermission(@Nonnull Inviteuser inviteuser) throws ApiException
      Update permission for a user `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"create_edit_deals\" - \"delete_deals\" - \"manage_others_deals_tasks\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" - `companies`: - \"manage_owned_companies\" - \"manage_other_companies\" - \"settings\" **Note**: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
      Parameters:
      inviteuser - Values to create an invitation (required)
      Returns:
      UpdateUserResponse
      Throws:
      ApiException - if fails to make API call

    • editUserPermission

      public UpdateUserResponse editUserPermission(@Nonnull Inviteuser inviteuser, Map<String,String> additionalHeaders) throws ApiException
      Update permission for a user `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"create_edit_deals\" - \"delete_deals\" - \"manage_others_deals_tasks\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" - `companies`: - \"manage_owned_companies\" - \"manage_other_companies\" - \"settings\" **Note**: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
      Parameters:
      inviteuser - Values to create an invitation (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UpdateUserResponse
      Throws:
      ApiException - if fails to make API call

    • getInvitedUsersList

      public GetInvitedUsersList getInvitedUsersList() throws ApiException
      Get the list of all your users
      Returns:
      GetInvitedUsersList
      Throws:
      ApiException - if fails to make API call

    • getInvitedUsersList

      public GetInvitedUsersList getInvitedUsersList(Map<String,String> additionalHeaders) throws ApiException
      Get the list of all your users
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetInvitedUsersList
      Throws:
      ApiException - if fails to make API call

    • getUserPermission

      public GetUserPermission getUserPermission(@Nonnull String email) throws ApiException
      Check user permission
      Parameters:
      email - Email of the invited user. (required)
      Returns:
      GetUserPermission
      Throws:
      ApiException - if fails to make API call

    • getUserPermission

      public GetUserPermission getUserPermission(@Nonnull String email, Map<String,String> additionalHeaders) throws ApiException
      Check user permission
      Parameters:
      email - Email of the invited user. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetUserPermission
      Throws:
      ApiException - if fails to make API call

    • inviteuser

      public InviteuserResponse inviteuser(@Nonnull Inviteuser inviteuser) throws ApiException
      Send invitation to user `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"create_edit_deals\" - \"delete_deals\" - \"manage_others_deals_tasks\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" - `companies`: - \"manage_owned_companies\" - \"manage_other_companies\" - \"settings\" **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 user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
      Parameters:
      inviteuser - Values to create an invitation (required)
      Returns:
      InviteuserResponse
      Throws:
      ApiException - if fails to make API call

    • inviteuser

      public InviteuserResponse inviteuser(@Nonnull Inviteuser inviteuser, Map<String,String> additionalHeaders) throws ApiException
      Send invitation to user `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"create_edit_deals\" - \"delete_deals\" - \"manage_others_deals_tasks\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" - `companies`: - \"manage_owned_companies\" - \"manage_other_companies\" - \"settings\" **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 user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
      Parameters:
      inviteuser - Values to create an invitation (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      InviteuserResponse
      Throws:
      ApiException - if fails to make API call

    • putRevokeUserPermission

      public PutRevokeUserPermissionResponse putRevokeUserPermission(@Nonnull String email) throws ApiException
      Revoke user permission
      Parameters:
      email - Email of the invited user. (required)
      Returns:
      PutRevokeUserPermissionResponse
      Throws:
      ApiException - if fails to make API call

    • putRevokeUserPermission

      public PutRevokeUserPermissionResponse putRevokeUserPermission(@Nonnull String email, Map<String,String> additionalHeaders) throws ApiException
      Revoke user permission
      Parameters:
      email - Email of the invited user. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      PutRevokeUserPermissionResponse
      Throws:
      ApiException - if fails to make API call

    • putresendcancelinvitation

      public PutresendcancelinvitationResponse putresendcancelinvitation(@Nonnull String action, @Nonnull String email) throws ApiException
      Resend / Cancel invitation
      Parameters:
      action - action (required)
      email - Email of the invited user. (required)
      Returns:
      PutresendcancelinvitationResponse
      Throws:
      ApiException - if fails to make API call

    • putresendcancelinvitation

      public PutresendcancelinvitationResponse putresendcancelinvitation(@Nonnull String action, @Nonnull String email, Map<String,String> additionalHeaders) throws ApiException
      Resend / Cancel invitation
      Parameters:
      action - action (required)
      email - Email of the invited user. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      PutresendcancelinvitationResponse
      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.