com.codedx.client.api

Class ProjectsApi

java.lang.Object

com.codedx.client.api.ProjectsApi

public class ProjectsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ProjectsApi()
ProjectsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	createProject(Project project) Create Project Create a new project.
com.squareup.okhttp.Call	createProjectAsync(Project project, ApiCallback<java.lang.Void> callback) Create Project (asynchronously) Create a new project.
com.squareup.okhttp.Call	createProjectCall(Project project, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createProject
ApiResponse<java.lang.Void>	createProjectWithHttpInfo(Project project) Create Project Create a new project.
void	deleteProject(java.lang.Integer projectId) Delete Project Delete a project.
com.squareup.okhttp.Call	deleteProjectAsync(java.lang.Integer projectId, ApiCallback<java.lang.Void> callback) Delete Project (asynchronously) Delete a project.
com.squareup.okhttp.Call	deleteProjectCall(java.lang.Integer projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteProject
ApiResponse<java.lang.Void>	deleteProjectWithHttpInfo(java.lang.Integer projectId) Delete Project Delete a project.
java.util.List<UserRole>	getAllUserRoles(java.lang.Integer projectId) User Roles Provides a list of all User roles.
com.squareup.okhttp.Call	getAllUserRolesAsync(java.lang.Integer projectId, ApiCallback<java.util.List<UserRole>> callback) User Roles (asynchronously) Provides a list of all User roles.
com.squareup.okhttp.Call	getAllUserRolesCall(java.lang.Integer projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllUserRoles
ApiResponse<java.util.List<UserRole>>	getAllUserRolesWithHttpInfo(java.lang.Integer projectId) User Roles Provides a list of all User roles.
ApiClient	getApiClient()
java.util.Map<java.lang.String,FileMapping>	getMappings(java.lang.Integer projectId, MappingsRequest request) File Mappings Provides source path mappings for a project.
com.squareup.okhttp.Call	getMappingsAsync(java.lang.Integer projectId, MappingsRequest request, ApiCallback<java.util.Map<java.lang.String,FileMapping>> callback) File Mappings (asynchronously) Provides source path mappings for a project.
com.squareup.okhttp.Call	getMappingsCall(java.lang.Integer projectId, MappingsRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getMappings
ApiResponse<java.util.Map<java.lang.String,FileMapping>>	getMappingsWithHttpInfo(java.lang.Integer projectId, MappingsRequest request) File Mappings Provides source path mappings for a project.
java.util.List<ProjectFile>	getProjectFiles(java.lang.Integer projectId) Project Files Provides a list of files for a project.
com.squareup.okhttp.Call	getProjectFilesAsync(java.lang.Integer projectId, ApiCallback<java.util.List<ProjectFile>> callback) Project Files (asynchronously) Provides a list of files for a project.
com.squareup.okhttp.Call	getProjectFilesCall(java.lang.Integer projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getProjectFiles
ApiResponse<java.util.List<ProjectFile>>	getProjectFilesWithHttpInfo(java.lang.Integer projectId) Project Files Provides a list of files for a project.
Projects	getProjects() List Projects Lists all projects.
com.squareup.okhttp.Call	getProjectsAsync(ApiCallback<Projects> callback) List Projects (asynchronously) Lists all projects.
com.squareup.okhttp.Call	getProjectsCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getProjects
ApiResponse<Projects>	getProjectsWithHttpInfo() List Projects Lists all projects.
java.util.Map<java.lang.String,Status>	getStatuses(java.lang.Integer projectId) Project Statuses Provides information on all valid triage statuses for a project.
com.squareup.okhttp.Call	getStatusesAsync(java.lang.Integer projectId, ApiCallback<java.util.Map<java.lang.String,Status>> callback) Project Statuses (asynchronously) Provides information on all valid triage statuses for a project.
com.squareup.okhttp.Call	getStatusesCall(java.lang.Integer projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getStatuses
ApiResponse<java.util.Map<java.lang.String,Status>>	getStatusesWithHttpInfo(java.lang.Integer projectId) Project Statuses Provides information on all valid triage statuses for a project.
UserRole	getUserRole(java.lang.Integer projectId, java.lang.Integer userId) User Role Provides a User Role for a given user.
com.squareup.okhttp.Call	getUserRoleAsync(java.lang.Integer projectId, java.lang.Integer userId, ApiCallback<UserRole> callback) User Role (asynchronously) Provides a User Role for a given user.
com.squareup.okhttp.Call	getUserRoleCall(java.lang.Integer projectId, java.lang.Integer userId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getUserRole
ApiResponse<UserRole>	getUserRoleWithHttpInfo(java.lang.Integer projectId, java.lang.Integer userId) User Role Provides a User Role for a given user.
java.util.List<ProjectQueryResponse>	queryProjects(ProjectQuery query) Query Projects Get a list of projects which match some filter/query criteria, and which you are allowed to view.
com.squareup.okhttp.Call	queryProjectsAsync(ProjectQuery query, ApiCallback<java.util.List<ProjectQueryResponse>> callback) Query Projects (asynchronously) Get a list of projects which match some filter/query criteria, and which you are allowed to view.
com.squareup.okhttp.Call	queryProjectsCall(ProjectQuery query, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for queryProjects
void	queryProjectsCount(ProjectQuery query) Query Projects Count Get the number of projects which match some filter/query criteria, and which you are allowed to view.
com.squareup.okhttp.Call	queryProjectsCountAsync(ProjectQuery query, ApiCallback<java.lang.Void> callback) Query Projects Count (asynchronously) Get the number of projects which match some filter/query criteria, and which you are allowed to view.
com.squareup.okhttp.Call	queryProjectsCountCall(ProjectQuery query, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for queryProjectsCount
ApiResponse<java.lang.Void>	queryProjectsCountWithHttpInfo(ProjectQuery query) Query Projects Count Get the number of projects which match some filter/query criteria, and which you are allowed to view.
ApiResponse<java.util.List<ProjectQueryResponse>>	queryProjectsWithHttpInfo(ProjectQuery query) Query Projects Get a list of projects which match some filter/query criteria, and which you are allowed to view.
void	setApiClient(ApiClient apiClient)
void	updateProject(java.lang.Integer projectId, UpdateProject body) Update Project Update a project by changing its name or parent
com.squareup.okhttp.Call	updateProjectAsync(java.lang.Integer projectId, UpdateProject body, ApiCallback<java.lang.Void> callback) Update Project (asynchronously) Update a project by changing its name or parent
com.squareup.okhttp.Call	updateProjectCall(java.lang.Integer projectId, UpdateProject body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateProject
ApiResponse<java.lang.Void>	updateProjectWithHttpInfo(java.lang.Integer projectId, UpdateProject body) Update Project Update a project by changing its name or parent
void	updateUserRole(java.lang.Integer projectId, java.lang.Integer userId, Roles request) Update User Role Allows changing user roles.
com.squareup.okhttp.Call	updateUserRoleAsync(java.lang.Integer projectId, java.lang.Integer userId, Roles request, ApiCallback<java.lang.Void> callback) Update User Role (asynchronously) Allows changing user roles.
com.squareup.okhttp.Call	updateUserRoleCall(java.lang.Integer projectId, java.lang.Integer userId, Roles request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateUserRole
ApiResponse<java.lang.Void>	updateUserRoleWithHttpInfo(java.lang.Integer projectId, java.lang.Integer userId, Roles request) Update User Role Allows changing user roles.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectsApi

public ProjectsApi()

ProjectsApi

public ProjectsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createProjectCall

public com.squareup.okhttp.Call createProjectCall(Project project,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for createProject

Parameters:

project - Project to add, omit id. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createProject

public void createProject(Project project)
                   throws ApiException

Create Project Create a new project.

Parameters:

project - Project to add, omit id. (required)

Throws:

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

createProjectWithHttpInfo

public ApiResponse<java.lang.Void> createProjectWithHttpInfo(Project project)
                                                      throws ApiException

Create Project Create a new project.

Parameters:

project - Project to add, omit id. (required)

Returns:

ApiResponse<Void>

Throws:

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

createProjectAsync

public com.squareup.okhttp.Call createProjectAsync(Project project,
                                                   ApiCallback<java.lang.Void> callback)
                                            throws ApiException

Create Project (asynchronously) Create a new project.

Parameters:

project - Project to add, omit id. (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

deleteProjectCall

public com.squareup.okhttp.Call deleteProjectCall(java.lang.Integer projectId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for deleteProject

Parameters:

projectId - The ID of the project. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteProject

public void deleteProject(java.lang.Integer projectId)
                   throws ApiException

Delete Project Delete a project.

Parameters:

projectId - The ID of the project. (required)

Throws:

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

deleteProjectWithHttpInfo

public ApiResponse<java.lang.Void> deleteProjectWithHttpInfo(java.lang.Integer projectId)
                                                      throws ApiException

Delete Project Delete a project.

Parameters:

projectId - The ID of the project. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteProjectAsync

public com.squareup.okhttp.Call deleteProjectAsync(java.lang.Integer projectId,
                                                   ApiCallback<java.lang.Void> callback)
                                            throws ApiException

Delete Project (asynchronously) Delete a project.

Parameters:

projectId - The ID of the project. (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

getAllUserRolesCall

public com.squareup.okhttp.Call getAllUserRolesCall(java.lang.Integer projectId,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for getAllUserRoles

Parameters:

projectId - The ID of the project. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllUserRoles

public java.util.List<UserRole> getAllUserRoles(java.lang.Integer projectId)
                                         throws ApiException

User Roles Provides a list of all User roles.

Parameters:

projectId - The ID of the project. (required)

Returns:

List<UserRole>

Throws:

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

getAllUserRolesWithHttpInfo

public ApiResponse<java.util.List<UserRole>> getAllUserRolesWithHttpInfo(java.lang.Integer projectId)
                                                                  throws ApiException

User Roles Provides a list of all User roles.

Parameters:

projectId - The ID of the project. (required)

Returns:

ApiResponse<List<UserRole>>

Throws:

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

getAllUserRolesAsync

public com.squareup.okhttp.Call getAllUserRolesAsync(java.lang.Integer projectId,
                                                     ApiCallback<java.util.List<UserRole>> callback)
                                              throws ApiException

User Roles (asynchronously) Provides a list of all User roles.

Parameters:

projectId - The ID of the project. (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

getMappingsCall

public com.squareup.okhttp.Call getMappingsCall(java.lang.Integer projectId,
                                                MappingsRequest request,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getMappings

Parameters:

projectId - The ID of the project. (required)

request - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getMappings

public java.util.Map<java.lang.String,FileMapping> getMappings(java.lang.Integer projectId,
                                                               MappingsRequest request)
                                                        throws ApiException

File Mappings Provides source path mappings for a project.

Parameters:

projectId - The ID of the project. (required)

request - (required)

Returns:

Map<String, FileMapping>

Throws:

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

getMappingsWithHttpInfo

public ApiResponse<java.util.Map<java.lang.String,FileMapping>> getMappingsWithHttpInfo(java.lang.Integer projectId,
                                                                                        MappingsRequest request)
                                                                                 throws ApiException

File Mappings Provides source path mappings for a project.

Parameters:

projectId - The ID of the project. (required)

request - (required)

Returns:

ApiResponse<Map<String, FileMapping>>

Throws:

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

getMappingsAsync

public com.squareup.okhttp.Call getMappingsAsync(java.lang.Integer projectId,
                                                 MappingsRequest request,
                                                 ApiCallback<java.util.Map<java.lang.String,FileMapping>> callback)
                                          throws ApiException

File Mappings (asynchronously) Provides source path mappings for a project.

Parameters:

projectId - The ID of the project. (required)

request - (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

getProjectFilesCall

public com.squareup.okhttp.Call getProjectFilesCall(java.lang.Integer projectId,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for getProjectFiles

Parameters:

projectId - The ID of the project. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getProjectFiles

public java.util.List<ProjectFile> getProjectFiles(java.lang.Integer projectId)
                                            throws ApiException

Project Files Provides a list of files for a project.

Parameters:

projectId - The ID of the project. (required)

Returns:

List<ProjectFile>

Throws:

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

getProjectFilesWithHttpInfo

public ApiResponse<java.util.List<ProjectFile>> getProjectFilesWithHttpInfo(java.lang.Integer projectId)
                                                                     throws ApiException

Project Files Provides a list of files for a project.

Parameters:

projectId - The ID of the project. (required)

Returns:

ApiResponse<List<ProjectFile>>

Throws:

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

getProjectFilesAsync

public com.squareup.okhttp.Call getProjectFilesAsync(java.lang.Integer projectId,
                                                     ApiCallback<java.util.List<ProjectFile>> callback)
                                              throws ApiException

Project Files (asynchronously) Provides a list of files for a project.

Parameters:

projectId - The ID of the project. (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

getProjectsCall

public com.squareup.okhttp.Call getProjectsCall(ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getProjects

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getProjects

public Projects getProjects()
                     throws ApiException

List Projects Lists all projects.

Returns:

Projects

Throws:

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

getProjectsWithHttpInfo

public ApiResponse<Projects> getProjectsWithHttpInfo()
                                              throws ApiException

List Projects Lists all projects.

Returns:

ApiResponse<Projects>

Throws:

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

getProjectsAsync

public com.squareup.okhttp.Call getProjectsAsync(ApiCallback<Projects> callback)
                                          throws ApiException

List Projects (asynchronously) Lists all projects.

Parameters:

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

getStatusesCall

public com.squareup.okhttp.Call getStatusesCall(java.lang.Integer projectId,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getStatuses

Parameters:

projectId - The ID of the project. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getStatuses

public java.util.Map<java.lang.String,Status> getStatuses(java.lang.Integer projectId)
                                                   throws ApiException

Project Statuses Provides information on all valid triage statuses for a project.

Parameters:

projectId - The ID of the project. (required)

Returns:

Map<String, Status>

Throws:

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

getStatusesWithHttpInfo

public ApiResponse<java.util.Map<java.lang.String,Status>> getStatusesWithHttpInfo(java.lang.Integer projectId)
                                                                            throws ApiException

Project Statuses Provides information on all valid triage statuses for a project.

Parameters:

projectId - The ID of the project. (required)

Returns:

ApiResponse<Map<String, Status>>

Throws:

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

getStatusesAsync

public com.squareup.okhttp.Call getStatusesAsync(java.lang.Integer projectId,
                                                 ApiCallback<java.util.Map<java.lang.String,Status>> callback)
                                          throws ApiException

Project Statuses (asynchronously) Provides information on all valid triage statuses for a project.

Parameters:

projectId - The ID of the project. (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

getUserRoleCall

public com.squareup.okhttp.Call getUserRoleCall(java.lang.Integer projectId,
                                                java.lang.Integer userId,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getUserRole

Parameters:

projectId - The ID of the project. (required)

userId - The user ID. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUserRole

public UserRole getUserRole(java.lang.Integer projectId,
                            java.lang.Integer userId)
                     throws ApiException

User Role Provides a User Role for a given user.

Parameters:

projectId - The ID of the project. (required)

userId - The user ID. (required)

Returns:

UserRole

Throws:

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

getUserRoleWithHttpInfo

public ApiResponse<UserRole> getUserRoleWithHttpInfo(java.lang.Integer projectId,
                                                     java.lang.Integer userId)
                                              throws ApiException

User Role Provides a User Role for a given user.

Parameters:

projectId - The ID of the project. (required)

userId - The user ID. (required)

Returns:

ApiResponse<UserRole>

Throws:

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

getUserRoleAsync

public com.squareup.okhttp.Call getUserRoleAsync(java.lang.Integer projectId,
                                                 java.lang.Integer userId,
                                                 ApiCallback<UserRole> callback)
                                          throws ApiException

User Role (asynchronously) Provides a User Role for a given user.

Parameters:

projectId - The ID of the project. (required)

userId - The user ID. (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

queryProjectsCall

public com.squareup.okhttp.Call queryProjectsCall(ProjectQuery query,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for queryProjects

Parameters:

query - Should be a JSON object with a \"filter\" field, which is an object with the following fields&#58; - `name` - an optional String. If given, specifies that each matching project should contain the given text in their name (case-insensitive) - `metadata` - an optional Object. If given, specifies that each matching project's metadata should match the criteria given in the metadata object. - `parentId` - an optional Integer or `null`. If given, specifies that each matching project should be a direct child of the parent project, or if `parentId` is `null`, each matching project should be a top-level project. Each of the fields in the filter object are optional, but the filter object itself is mandatory. A blank `filter` object matches all projects. The `filter.metadata` Object's keys and values should be the names of Project Metadata Fields and their respective search criteria. The value for each field will be interpreted according to that field's type&#58; - **Text** and **Multiline** fields will check if the value is present in the project's value for that field (case-insensitive) - **Tags** fields will interpret the value as a set of tags, and will check if the project's tags contains at least one of them (case-insensitive) - **Dropdown** fields will check if the project's selected value is equal to the criteria value (case-insensitive) Note that in some cases, you may need to specify the metadata field by its ID (e.g. if two different fields have the same name, or if you simply would prefer to use ID instead of name). In these cases, you can use a string in the format `id:<ID>` (e.g. `id:3`) in place of the field name as a key in the metadata criteria object. This endpoint also supports pagination via the optional `offset` and `limit` fields, which may be specified in the body alongside the `filter`. Specifying an `offset` without also specifying a `limit` is an error. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

queryProjects

public java.util.List<ProjectQueryResponse> queryProjects(ProjectQuery query)
                                                   throws ApiException

Query Projects Get a list of projects which match some filter/query criteria, and which you are allowed to view.

Parameters:

query - Should be a JSON object with a \"filter\" field, which is an object with the following fields&#58; - `name` - an optional String. If given, specifies that each matching project should contain the given text in their name (case-insensitive) - `metadata` - an optional Object. If given, specifies that each matching project's metadata should match the criteria given in the metadata object. - `parentId` - an optional Integer or `null`. If given, specifies that each matching project should be a direct child of the parent project, or if `parentId` is `null`, each matching project should be a top-level project. Each of the fields in the filter object are optional, but the filter object itself is mandatory. A blank `filter` object matches all projects. The `filter.metadata` Object's keys and values should be the names of Project Metadata Fields and their respective search criteria. The value for each field will be interpreted according to that field's type&#58; - **Text** and **Multiline** fields will check if the value is present in the project's value for that field (case-insensitive) - **Tags** fields will interpret the value as a set of tags, and will check if the project's tags contains at least one of them (case-insensitive) - **Dropdown** fields will check if the project's selected value is equal to the criteria value (case-insensitive) Note that in some cases, you may need to specify the metadata field by its ID (e.g. if two different fields have the same name, or if you simply would prefer to use ID instead of name). In these cases, you can use a string in the format `id:<ID>` (e.g. `id:3`) in place of the field name as a key in the metadata criteria object. This endpoint also supports pagination via the optional `offset` and `limit` fields, which may be specified in the body alongside the `filter`. Specifying an `offset` without also specifying a `limit` is an error. (required)

Returns:

List<ProjectQueryResponse>

Throws:

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

queryProjectsWithHttpInfo

public ApiResponse<java.util.List<ProjectQueryResponse>> queryProjectsWithHttpInfo(ProjectQuery query)
                                                                            throws ApiException

Query Projects Get a list of projects which match some filter/query criteria, and which you are allowed to view.

Parameters:

query - Should be a JSON object with a \"filter\" field, which is an object with the following fields&#58; - `name` - an optional String. If given, specifies that each matching project should contain the given text in their name (case-insensitive) - `metadata` - an optional Object. If given, specifies that each matching project's metadata should match the criteria given in the metadata object. - `parentId` - an optional Integer or `null`. If given, specifies that each matching project should be a direct child of the parent project, or if `parentId` is `null`, each matching project should be a top-level project. Each of the fields in the filter object are optional, but the filter object itself is mandatory. A blank `filter` object matches all projects. The `filter.metadata` Object's keys and values should be the names of Project Metadata Fields and their respective search criteria. The value for each field will be interpreted according to that field's type&#58; - **Text** and **Multiline** fields will check if the value is present in the project's value for that field (case-insensitive) - **Tags** fields will interpret the value as a set of tags, and will check if the project's tags contains at least one of them (case-insensitive) - **Dropdown** fields will check if the project's selected value is equal to the criteria value (case-insensitive) Note that in some cases, you may need to specify the metadata field by its ID (e.g. if two different fields have the same name, or if you simply would prefer to use ID instead of name). In these cases, you can use a string in the format `id:<ID>` (e.g. `id:3`) in place of the field name as a key in the metadata criteria object. This endpoint also supports pagination via the optional `offset` and `limit` fields, which may be specified in the body alongside the `filter`. Specifying an `offset` without also specifying a `limit` is an error. (required)

Returns:

ApiResponse<List<ProjectQueryResponse>>

Throws:

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

queryProjectsAsync

public com.squareup.okhttp.Call queryProjectsAsync(ProjectQuery query,
                                                   ApiCallback<java.util.List<ProjectQueryResponse>> callback)
                                            throws ApiException

Query Projects (asynchronously) Get a list of projects which match some filter/query criteria, and which you are allowed to view.

Parameters:

query - Should be a JSON object with a \"filter\" field, which is an object with the following fields&#58; - `name` - an optional String. If given, specifies that each matching project should contain the given text in their name (case-insensitive) - `metadata` - an optional Object. If given, specifies that each matching project's metadata should match the criteria given in the metadata object. - `parentId` - an optional Integer or `null`. If given, specifies that each matching project should be a direct child of the parent project, or if `parentId` is `null`, each matching project should be a top-level project. Each of the fields in the filter object are optional, but the filter object itself is mandatory. A blank `filter` object matches all projects. The `filter.metadata` Object's keys and values should be the names of Project Metadata Fields and their respective search criteria. The value for each field will be interpreted according to that field's type&#58; - **Text** and **Multiline** fields will check if the value is present in the project's value for that field (case-insensitive) - **Tags** fields will interpret the value as a set of tags, and will check if the project's tags contains at least one of them (case-insensitive) - **Dropdown** fields will check if the project's selected value is equal to the criteria value (case-insensitive) Note that in some cases, you may need to specify the metadata field by its ID (e.g. if two different fields have the same name, or if you simply would prefer to use ID instead of name). In these cases, you can use a string in the format `id:<ID>` (e.g. `id:3`) in place of the field name as a key in the metadata criteria object. This endpoint also supports pagination via the optional `offset` and `limit` fields, which may be specified in the body alongside the `filter`. Specifying an `offset` without also specifying a `limit` is an error. (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

queryProjectsCountCall

public com.squareup.okhttp.Call queryProjectsCountCall(ProjectQuery query,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for queryProjectsCount

Parameters:

query - Should be a JSON object with a \"filter\" field. See the \"Query Projects\" endpoint (above) for details. Note that while the model for this request body is the same as with \"Query Projects\", the `offset` and `limit` fields will be ignored. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

queryProjectsCount

public void queryProjectsCount(ProjectQuery query)
                        throws ApiException

Query Projects Count Get the number of projects which match some filter/query criteria, and which you are allowed to view.

Parameters:

query - Should be a JSON object with a \"filter\" field. See the \"Query Projects\" endpoint (above) for details. Note that while the model for this request body is the same as with \"Query Projects\", the `offset` and `limit` fields will be ignored. (required)

Throws:

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

queryProjectsCountWithHttpInfo

public ApiResponse<java.lang.Void> queryProjectsCountWithHttpInfo(ProjectQuery query)
                                                           throws ApiException

Query Projects Count Get the number of projects which match some filter/query criteria, and which you are allowed to view.

Parameters:

query - Should be a JSON object with a \"filter\" field. See the \"Query Projects\" endpoint (above) for details. Note that while the model for this request body is the same as with \"Query Projects\", the `offset` and `limit` fields will be ignored. (required)

Returns:

ApiResponse<Void>

Throws:

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

queryProjectsCountAsync

public com.squareup.okhttp.Call queryProjectsCountAsync(ProjectQuery query,
                                                        ApiCallback<java.lang.Void> callback)
                                                 throws ApiException

Query Projects Count (asynchronously) Get the number of projects which match some filter/query criteria, and which you are allowed to view.

Parameters:

query - Should be a JSON object with a \"filter\" field. See the \"Query Projects\" endpoint (above) for details. Note that while the model for this request body is the same as with \"Query Projects\", the `offset` and `limit` fields will be ignored. (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

updateProjectCall

public com.squareup.okhttp.Call updateProjectCall(java.lang.Integer projectId,
                                                  UpdateProject body,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for updateProject

Parameters:

projectId - The ID of the project. (required)

body - Request Body should be a JSON object with the following fields#58; - `name` (String) if provided, specifies the new name for the project - `parentId` (Number | null) if provided, specifies the ID of the project's parent (for project grouping) (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateProject

public void updateProject(java.lang.Integer projectId,
                          UpdateProject body)
                   throws ApiException

Update Project Update a project by changing its name or parent

Parameters:

projectId - The ID of the project. (required)

body - Request Body should be a JSON object with the following fields#58; - `name` (String) if provided, specifies the new name for the project - `parentId` (Number | null) if provided, specifies the ID of the project's parent (for project grouping) (required)

Throws:

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

updateProjectWithHttpInfo

public ApiResponse<java.lang.Void> updateProjectWithHttpInfo(java.lang.Integer projectId,
                                                             UpdateProject body)
                                                      throws ApiException

Update Project Update a project by changing its name or parent

Parameters:

projectId - The ID of the project. (required)

body - Request Body should be a JSON object with the following fields#58; - `name` (String) if provided, specifies the new name for the project - `parentId` (Number | null) if provided, specifies the ID of the project's parent (for project grouping) (required)

Returns:

ApiResponse<Void>

Throws:

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

updateProjectAsync

public com.squareup.okhttp.Call updateProjectAsync(java.lang.Integer projectId,
                                                   UpdateProject body,
                                                   ApiCallback<java.lang.Void> callback)
                                            throws ApiException

Update Project (asynchronously) Update a project by changing its name or parent

Parameters:

projectId - The ID of the project. (required)

body - Request Body should be a JSON object with the following fields#58; - `name` (String) if provided, specifies the new name for the project - `parentId` (Number | null) if provided, specifies the ID of the project's parent (for project grouping) (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

updateUserRoleCall

public com.squareup.okhttp.Call updateUserRoleCall(java.lang.Integer projectId,
                                                   java.lang.Integer userId,
                                                   Roles request,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for updateUserRole

Parameters:

projectId - The ID of the project. (required)

userId - The user ID. (required)

request - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateUserRole

public void updateUserRole(java.lang.Integer projectId,
                           java.lang.Integer userId,
                           Roles request)
                    throws ApiException

Update User Role Allows changing user roles. Note that you must specify the entire set of roles each time; if you fail to include a role when using this method, the user will lose that role.

Parameters:

projectId - The ID of the project. (required)

userId - The user ID. (required)

request - (required)

Throws:

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

updateUserRoleWithHttpInfo

public ApiResponse<java.lang.Void> updateUserRoleWithHttpInfo(java.lang.Integer projectId,
                                                              java.lang.Integer userId,
                                                              Roles request)
                                                       throws ApiException

Update User Role Allows changing user roles. Note that you must specify the entire set of roles each time; if you fail to include a role when using this method, the user will lose that role.

Parameters:

projectId - The ID of the project. (required)

userId - The user ID. (required)

request - (required)

Returns:

ApiResponse<Void>

Throws:

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

updateUserRoleAsync

public com.squareup.okhttp.Call updateUserRoleAsync(java.lang.Integer projectId,
                                                    java.lang.Integer userId,
                                                    Roles request,
                                                    ApiCallback<java.lang.Void> callback)
                                             throws ApiException

Update User Role (asynchronously) Allows changing user roles. Note that you must specify the entire set of roles each time; if you fail to include a role when using this method, the user will lose that role.

Parameters:

projectId - The ID of the project. (required)

userId - The user ID. (required)

request - (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