com.configcat.publicapi.java.client.api

Class MembersApi

java.lang.Object

com.configcat.publicapi.java.client.api.MembersApi

public class MembersApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MembersApi()
MembersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	addMemberToGroup(java.util.UUID organizationId, java.lang.String userId, UpdateMemberPermissionsRequest updateMemberPermissionsRequest) Update Member Permissions This endpoint updates the permissions of a Member identified by the `userId`.
okhttp3.Call	addMemberToGroupAsync(java.util.UUID organizationId, java.lang.String userId, UpdateMemberPermissionsRequest updateMemberPermissionsRequest, ApiCallback<java.lang.Void> _callback) Update Member Permissions (asynchronously) This endpoint updates the permissions of a Member identified by the `userId`.
okhttp3.Call	addMemberToGroupCall(java.util.UUID organizationId, java.lang.String userId, UpdateMemberPermissionsRequest updateMemberPermissionsRequest, ApiCallback _callback) Build call for addMemberToGroup
ApiResponse<java.lang.Void>	addMemberToGroupWithHttpInfo(java.util.UUID organizationId, java.lang.String userId, UpdateMemberPermissionsRequest updateMemberPermissionsRequest) Update Member Permissions This endpoint updates the permissions of a Member identified by the `userId`.
void	deleteInvitation(java.util.UUID invitationId) Delete Invitation This endpoint removes an Invitation identified by the `invitationId` parameter.
okhttp3.Call	deleteInvitationAsync(java.util.UUID invitationId, ApiCallback<java.lang.Void> _callback) Delete Invitation (asynchronously) This endpoint removes an Invitation identified by the `invitationId` parameter.
okhttp3.Call	deleteInvitationCall(java.util.UUID invitationId, ApiCallback _callback) Build call for deleteInvitation
ApiResponse<java.lang.Void>	deleteInvitationWithHttpInfo(java.util.UUID invitationId) Delete Invitation This endpoint removes an Invitation identified by the `invitationId` parameter.
void	deleteOrganizationMember(java.util.UUID organizationId, java.lang.String userId) Delete Member from Organization This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter.
okhttp3.Call	deleteOrganizationMemberAsync(java.util.UUID organizationId, java.lang.String userId, ApiCallback<java.lang.Void> _callback) Delete Member from Organization (asynchronously) This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter.
okhttp3.Call	deleteOrganizationMemberCall(java.util.UUID organizationId, java.lang.String userId, ApiCallback _callback) Build call for deleteOrganizationMember
ApiResponse<java.lang.Void>	deleteOrganizationMemberWithHttpInfo(java.util.UUID organizationId, java.lang.String userId) Delete Member from Organization This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter.
void	deleteProductMember(java.util.UUID productId, java.lang.String userId) Delete Member from Product This endpoint removes a Member identified by the `userId` from the given Product identified by the `productId` parameter.
okhttp3.Call	deleteProductMemberAsync(java.util.UUID productId, java.lang.String userId, ApiCallback<java.lang.Void> _callback) Delete Member from Product (asynchronously) This endpoint removes a Member identified by the `userId` from the given Product identified by the `productId` parameter.
okhttp3.Call	deleteProductMemberCall(java.util.UUID productId, java.lang.String userId, ApiCallback _callback) Build call for deleteProductMember
ApiResponse<java.lang.Void>	deleteProductMemberWithHttpInfo(java.util.UUID productId, java.lang.String userId) Delete Member from Product This endpoint removes a Member identified by the `userId` from the given Product identified by the `productId` parameter.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
java.util.List<UserModel>	getOrganizationMembers(java.util.UUID organizationId) Deprecated.
okhttp3.Call	getOrganizationMembersAsync(java.util.UUID organizationId, ApiCallback<java.util.List<UserModel>> _callback) Deprecated.
okhttp3.Call	getOrganizationMembersCall(java.util.UUID organizationId, ApiCallback _callback) Deprecated.
OrganizationMembersModel	getOrganizationMembersV2(java.util.UUID organizationId) List Organization Members This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter.
okhttp3.Call	getOrganizationMembersV2Async(java.util.UUID organizationId, ApiCallback<OrganizationMembersModel> _callback) List Organization Members (asynchronously) This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter.
okhttp3.Call	getOrganizationMembersV2Call(java.util.UUID organizationId, ApiCallback _callback) Build call for getOrganizationMembersV2
ApiResponse<OrganizationMembersModel>	getOrganizationMembersV2WithHttpInfo(java.util.UUID organizationId) List Organization Members This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter.
ApiResponse<java.util.List<UserModel>>	getOrganizationMembersWithHttpInfo(java.util.UUID organizationId) Deprecated.
java.util.List<InvitationModel>	getPendingInvitations(java.util.UUID productId) List Pending Invitations in Product This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter.
okhttp3.Call	getPendingInvitationsAsync(java.util.UUID productId, ApiCallback<java.util.List<InvitationModel>> _callback) List Pending Invitations in Product (asynchronously) This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter.
okhttp3.Call	getPendingInvitationsCall(java.util.UUID productId, ApiCallback _callback) Build call for getPendingInvitations
java.util.List<OrganizationInvitationModel>	getPendingInvitationsOrg(java.util.UUID organizationId) List Pending Invitations in Organization This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter.
okhttp3.Call	getPendingInvitationsOrgAsync(java.util.UUID organizationId, ApiCallback<java.util.List<OrganizationInvitationModel>> _callback) List Pending Invitations in Organization (asynchronously) This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter.
okhttp3.Call	getPendingInvitationsOrgCall(java.util.UUID organizationId, ApiCallback _callback) Build call for getPendingInvitationsOrg
ApiResponse<java.util.List<OrganizationInvitationModel>>	getPendingInvitationsOrgWithHttpInfo(java.util.UUID organizationId) List Pending Invitations in Organization This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter.
ApiResponse<java.util.List<InvitationModel>>	getPendingInvitationsWithHttpInfo(java.util.UUID productId) List Pending Invitations in Product This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter.
java.util.List<MemberModel>	getProductMembers(java.util.UUID productId) List Product Members This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter.
okhttp3.Call	getProductMembersAsync(java.util.UUID productId, ApiCallback<java.util.List<MemberModel>> _callback) List Product Members (asynchronously) This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter.
okhttp3.Call	getProductMembersCall(java.util.UUID productId, ApiCallback _callback) Build call for getProductMembers
ApiResponse<java.util.List<MemberModel>>	getProductMembersWithHttpInfo(java.util.UUID productId) List Product Members This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter.
void	inviteMember(java.util.UUID productId, InviteMembersRequest inviteMembersRequest) Invite Member This endpoint invites a Member into the given Product identified by the `productId` parameter.
okhttp3.Call	inviteMemberAsync(java.util.UUID productId, InviteMembersRequest inviteMembersRequest, ApiCallback<java.lang.Void> _callback) Invite Member (asynchronously) This endpoint invites a Member into the given Product identified by the `productId` parameter.
okhttp3.Call	inviteMemberCall(java.util.UUID productId, InviteMembersRequest inviteMembersRequest, ApiCallback _callback) Build call for inviteMember
ApiResponse<java.lang.Void>	inviteMemberWithHttpInfo(java.util.UUID productId, InviteMembersRequest inviteMembersRequest) Invite Member This endpoint invites a Member into the given Product identified by the `productId` parameter.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

MembersApi

public MembersApi()

MembersApi

public MembersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

addMemberToGroupCall

public okhttp3.Call addMemberToGroupCall(java.util.UUID organizationId,
                                         java.lang.String userId,
                                         UpdateMemberPermissionsRequest updateMemberPermissionsRequest,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for addMemberToGroup

Parameters:

organizationId - The identifier of the Organization. (required)

userId - The identifier of the Member. (required)

updateMemberPermissionsRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

addMemberToGroup

public void addMemberToGroup(java.util.UUID organizationId,
                             java.lang.String userId,
                             UpdateMemberPermissionsRequest updateMemberPermissionsRequest)
                      throws ApiException

Update Member Permissions This endpoint updates the permissions of a Member identified by the `userId`. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product.

Parameters:

organizationId - The identifier of the Organization. (required)

userId - The identifier of the Member. (required)

updateMemberPermissionsRequest - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

addMemberToGroupWithHttpInfo

public ApiResponse<java.lang.Void> addMemberToGroupWithHttpInfo(java.util.UUID organizationId,
                                                                java.lang.String userId,
                                                                UpdateMemberPermissionsRequest updateMemberPermissionsRequest)
                                                         throws ApiException

Update Member Permissions This endpoint updates the permissions of a Member identified by the `userId`. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product.

Parameters:

organizationId - The identifier of the Organization. (required)

userId - The identifier of the Member. (required)

updateMemberPermissionsRequest - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

addMemberToGroupAsync

public okhttp3.Call addMemberToGroupAsync(java.util.UUID organizationId,
                                          java.lang.String userId,
                                          UpdateMemberPermissionsRequest updateMemberPermissionsRequest,
                                          ApiCallback<java.lang.Void> _callback)
                                   throws ApiException

Update Member Permissions (asynchronously) This endpoint updates the permissions of a Member identified by the `userId`. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product.

Parameters:

organizationId - The identifier of the Organization. (required)

userId - The identifier of the Member. (required)

updateMemberPermissionsRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteInvitationCall

public okhttp3.Call deleteInvitationCall(java.util.UUID invitationId,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for deleteInvitation

Parameters:

invitationId - The identifier of the Invitation. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteInvitation

public void deleteInvitation(java.util.UUID invitationId)
                      throws ApiException

Delete Invitation This endpoint removes an Invitation identified by the `invitationId` parameter.

Parameters:

invitationId - The identifier of the Invitation. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteInvitationWithHttpInfo

public ApiResponse<java.lang.Void> deleteInvitationWithHttpInfo(java.util.UUID invitationId)
                                                         throws ApiException

Delete Invitation This endpoint removes an Invitation identified by the `invitationId` parameter.

Parameters:

invitationId - The identifier of the Invitation. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteInvitationAsync

public okhttp3.Call deleteInvitationAsync(java.util.UUID invitationId,
                                          ApiCallback<java.lang.Void> _callback)
                                   throws ApiException

Delete Invitation (asynchronously) This endpoint removes an Invitation identified by the `invitationId` parameter.

Parameters:

invitationId - The identifier of the Invitation. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteOrganizationMemberCall

public okhttp3.Call deleteOrganizationMemberCall(java.util.UUID organizationId,
                                                 java.lang.String userId,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for deleteOrganizationMember

Parameters:

organizationId - The identifier of the Organization. (required)

userId - The identifier of the Member. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteOrganizationMember

public void deleteOrganizationMember(java.util.UUID organizationId,
                                     java.lang.String userId)
                              throws ApiException

Delete Member from Organization This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter.

Parameters:

organizationId - The identifier of the Organization. (required)

userId - The identifier of the Member. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteOrganizationMemberWithHttpInfo

public ApiResponse<java.lang.Void> deleteOrganizationMemberWithHttpInfo(java.util.UUID organizationId,
                                                                        java.lang.String userId)
                                                                 throws ApiException

Delete Member from Organization This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter.

Parameters:

organizationId - The identifier of the Organization. (required)

userId - The identifier of the Member. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteOrganizationMemberAsync

public okhttp3.Call deleteOrganizationMemberAsync(java.util.UUID organizationId,
                                                  java.lang.String userId,
                                                  ApiCallback<java.lang.Void> _callback)
                                           throws ApiException

Delete Member from Organization (asynchronously) This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter.

Parameters:

organizationId - The identifier of the Organization. (required)

userId - The identifier of the Member. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteProductMemberCall

public okhttp3.Call deleteProductMemberCall(java.util.UUID productId,
                                            java.lang.String userId,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for deleteProductMember

Parameters:

productId - The identifier of the Product. (required)

userId - The identifier of the Member. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteProductMember

public void deleteProductMember(java.util.UUID productId,
                                java.lang.String userId)
                         throws ApiException

Delete Member from Product This endpoint removes a Member identified by the `userId` from the given Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

userId - The identifier of the Member. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteProductMemberWithHttpInfo

public ApiResponse<java.lang.Void> deleteProductMemberWithHttpInfo(java.util.UUID productId,
                                                                   java.lang.String userId)
                                                            throws ApiException

Delete Member from Product This endpoint removes a Member identified by the `userId` from the given Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

userId - The identifier of the Member. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteProductMemberAsync

public okhttp3.Call deleteProductMemberAsync(java.util.UUID productId,
                                             java.lang.String userId,
                                             ApiCallback<java.lang.Void> _callback)
                                      throws ApiException

Delete Member from Product (asynchronously) This endpoint removes a Member identified by the `userId` from the given Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

userId - The identifier of the Member. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembersCall

@Deprecated
public okhttp3.Call getOrganizationMembersCall(java.util.UUID organizationId,
                                                           ApiCallback _callback)
                                                    throws ApiException

Deprecated.

Build call for getOrganizationMembers

Parameters:

organizationId - The identifier of the Organization. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembers

@Deprecated
public java.util.List<UserModel> getOrganizationMembers(java.util.UUID organizationId)
                                                             throws ApiException

Deprecated.

List Organization Members This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter. The results may vary based on the access level of the user who calls the endpoint: - When it's called with Organization Admin privileges, the result will contain each member in the Organization. - When it's called without Organization Admin privileges, the result will contain each Organization Admin along with members of those products where the caller has `Team members and permission groups` (`canManageMembers`) permission.

Parameters:

organizationId - The identifier of the Organization. (required)

Returns:

List<UserModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembersWithHttpInfo

@Deprecated
public ApiResponse<java.util.List<UserModel>> getOrganizationMembersWithHttpInfo(java.util.UUID organizationId)
                                                                                      throws ApiException

Deprecated.

List Organization Members This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter. The results may vary based on the access level of the user who calls the endpoint: - When it's called with Organization Admin privileges, the result will contain each member in the Organization. - When it's called without Organization Admin privileges, the result will contain each Organization Admin along with members of those products where the caller has `Team members and permission groups` (`canManageMembers`) permission.

Parameters:

organizationId - The identifier of the Organization. (required)

Returns:

ApiResponse<List<UserModel>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembersAsync

@Deprecated
public okhttp3.Call getOrganizationMembersAsync(java.util.UUID organizationId,
                                                            ApiCallback<java.util.List<UserModel>> _callback)
                                                     throws ApiException

Deprecated.

List Organization Members (asynchronously) This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter. The results may vary based on the access level of the user who calls the endpoint: - When it's called with Organization Admin privileges, the result will contain each member in the Organization. - When it's called without Organization Admin privileges, the result will contain each Organization Admin along with members of those products where the caller has `Team members and permission groups` (`canManageMembers`) permission.

Parameters:

organizationId - The identifier of the Organization. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembersV2Call

public okhttp3.Call getOrganizationMembersV2Call(java.util.UUID organizationId,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for getOrganizationMembersV2

Parameters:

organizationId - The identifier of the Organization. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembersV2

public OrganizationMembersModel getOrganizationMembersV2(java.util.UUID organizationId)
                                                  throws ApiException

List Organization Members This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter. The results may vary based on the access level of the user who calls the endpoint: - When it's called with Organization Admin privileges, the result will contain each member in the Organization. - When it's called without Organization Admin privileges, the result will contain each Organization Admin along with members of those products where the caller has `Team members and permission groups` (`canManageMembers`) permission.

Parameters:

organizationId - The identifier of the Organization. (required)

Returns:

OrganizationMembersModel

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembersV2WithHttpInfo

public ApiResponse<OrganizationMembersModel> getOrganizationMembersV2WithHttpInfo(java.util.UUID organizationId)
                                                                           throws ApiException

List Organization Members This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter. The results may vary based on the access level of the user who calls the endpoint: - When it's called with Organization Admin privileges, the result will contain each member in the Organization. - When it's called without Organization Admin privileges, the result will contain each Organization Admin along with members of those products where the caller has `Team members and permission groups` (`canManageMembers`) permission.

Parameters:

organizationId - The identifier of the Organization. (required)

Returns:

ApiResponse<OrganizationMembersModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembersV2Async

public okhttp3.Call getOrganizationMembersV2Async(java.util.UUID organizationId,
                                                  ApiCallback<OrganizationMembersModel> _callback)
                                           throws ApiException

List Organization Members (asynchronously) This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter. The results may vary based on the access level of the user who calls the endpoint: - When it's called with Organization Admin privileges, the result will contain each member in the Organization. - When it's called without Organization Admin privileges, the result will contain each Organization Admin along with members of those products where the caller has `Team members and permission groups` (`canManageMembers`) permission.

Parameters:

organizationId - The identifier of the Organization. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitationsCall

public okhttp3.Call getPendingInvitationsCall(java.util.UUID productId,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getPendingInvitations

Parameters:

productId - The identifier of the Product. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitations

public java.util.List<InvitationModel> getPendingInvitations(java.util.UUID productId)
                                                      throws ApiException

List Pending Invitations in Product This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

Returns:

List<InvitationModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitationsWithHttpInfo

public ApiResponse<java.util.List<InvitationModel>> getPendingInvitationsWithHttpInfo(java.util.UUID productId)
                                                                               throws ApiException

List Pending Invitations in Product This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

Returns:

ApiResponse<List<InvitationModel>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitationsAsync

public okhttp3.Call getPendingInvitationsAsync(java.util.UUID productId,
                                               ApiCallback<java.util.List<InvitationModel>> _callback)
                                        throws ApiException

List Pending Invitations in Product (asynchronously) This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitationsOrgCall

public okhttp3.Call getPendingInvitationsOrgCall(java.util.UUID organizationId,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for getPendingInvitationsOrg

Parameters:

organizationId - The identifier of the Organization. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitationsOrg

public java.util.List<OrganizationInvitationModel> getPendingInvitationsOrg(java.util.UUID organizationId)
                                                                     throws ApiException

List Pending Invitations in Organization This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter.

Parameters:

organizationId - The identifier of the Organization. (required)

Returns:

List<OrganizationInvitationModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitationsOrgWithHttpInfo

public ApiResponse<java.util.List<OrganizationInvitationModel>> getPendingInvitationsOrgWithHttpInfo(java.util.UUID organizationId)
                                                                                              throws ApiException

List Pending Invitations in Organization This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter.

Parameters:

organizationId - The identifier of the Organization. (required)

Returns:

ApiResponse<List<OrganizationInvitationModel>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitationsOrgAsync

public okhttp3.Call getPendingInvitationsOrgAsync(java.util.UUID organizationId,
                                                  ApiCallback<java.util.List<OrganizationInvitationModel>> _callback)
                                           throws ApiException

List Pending Invitations in Organization (asynchronously) This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter.

Parameters:

organizationId - The identifier of the Organization. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductMembersCall

public okhttp3.Call getProductMembersCall(java.util.UUID productId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getProductMembers

Parameters:

productId - The identifier of the Product. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductMembers

public java.util.List<MemberModel> getProductMembers(java.util.UUID productId)
                                              throws ApiException

List Product Members This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

Returns:

List<MemberModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductMembersWithHttpInfo

public ApiResponse<java.util.List<MemberModel>> getProductMembersWithHttpInfo(java.util.UUID productId)
                                                                       throws ApiException

List Product Members This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

Returns:

ApiResponse<List<MemberModel>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductMembersAsync

public okhttp3.Call getProductMembersAsync(java.util.UUID productId,
                                           ApiCallback<java.util.List<MemberModel>> _callback)
                                    throws ApiException

List Product Members (asynchronously) This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

inviteMemberCall

public okhttp3.Call inviteMemberCall(java.util.UUID productId,
                                     InviteMembersRequest inviteMembersRequest,
                                     ApiCallback _callback)
                              throws ApiException

Build call for inviteMember

Parameters:

productId - The identifier of the Product. (required)

inviteMembersRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When the invite was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

inviteMember

public void inviteMember(java.util.UUID productId,
                         InviteMembersRequest inviteMembersRequest)
                  throws ApiException

Invite Member This endpoint invites a Member into the given Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

inviteMembersRequest - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When the invite was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

inviteMemberWithHttpInfo

public ApiResponse<java.lang.Void> inviteMemberWithHttpInfo(java.util.UUID productId,
                                                            InviteMembersRequest inviteMembersRequest)
                                                     throws ApiException

Invite Member This endpoint invites a Member into the given Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

inviteMembersRequest - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When the invite was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

inviteMemberAsync

public okhttp3.Call inviteMemberAsync(java.util.UUID productId,
                                      InviteMembersRequest inviteMembersRequest,
                                      ApiCallback<java.lang.Void> _callback)
                               throws ApiException

Invite Member (asynchronously) This endpoint invites a Member into the given Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

inviteMembersRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	When the invite was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-