All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.factset.sdk.IRNNotes.api.CommentsApi Maven / Gradle / Ivy

There is a newer version: 4.0.1
Show newest version
package com.factset.sdk.IRNNotes.api;

import com.factset.sdk.IRNNotes.ApiException;
import com.factset.sdk.IRNNotes.ApiClient;
import com.factset.sdk.IRNNotes.ApiResponse;
import com.factset.sdk.IRNNotes.Configuration;
import com.factset.sdk.IRNNotes.Pair;

import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

import com.factset.sdk.IRNNotes.models.AttachmentSummaryDto;
import com.factset.sdk.IRNNotes.models.CommentDto;
import com.factset.sdk.IRNNotes.models.CommentSummaryDto;
import com.factset.sdk.IRNNotes.models.CreateCommentDto;
import java.io.File;
import com.factset.sdk.IRNNotes.models.NewItemDto;
import com.factset.sdk.IRNNotes.models.Operation;
import com.factset.sdk.IRNNotes.models.ProblemDetails;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")

public class CommentsApi {
  private ApiClient apiClient;

  public CommentsApi() {
    this(Configuration.getDefaultApiClient());
  }

  public CommentsApi(ApiClient apiClient) {
    this.apiClient = apiClient;
  }
  
  private static final Map createCommentResponseTypeMap = new HashMap();
  static {
    createCommentResponseTypeMap.put(201, new GenericType(){});
    createCommentResponseTypeMap.put(400, new GenericType(){});
    createCommentResponseTypeMap.put(403, new GenericType(){});
    createCommentResponseTypeMap.put(404, new GenericType(){});
  }

  private static final Map createCommentAttachmentResponseTypeMap = new HashMap();
  static {
    createCommentAttachmentResponseTypeMap.put(201, new GenericType(){});
    createCommentAttachmentResponseTypeMap.put(400, new GenericType(){});
    createCommentAttachmentResponseTypeMap.put(403, new GenericType(){});
    createCommentAttachmentResponseTypeMap.put(404, new GenericType(){});
  }

  private static final Map deleteCommentResponseTypeMap = new HashMap();

  private static final Map downloadCommentAttachmentForCommentResponseTypeMap = new HashMap();

  private static final Map getCommentResponseTypeMap = new HashMap();
  static {
    getCommentResponseTypeMap.put(200, new GenericType(){});
    getCommentResponseTypeMap.put(400, new GenericType(){});
    getCommentResponseTypeMap.put(403, new GenericType(){});
    getCommentResponseTypeMap.put(404, new GenericType(){});
  }

  private static final Map getCommentAttachmentsResponseTypeMap = new HashMap();
  static {
    getCommentAttachmentsResponseTypeMap.put(200, new GenericType>(){});
    getCommentAttachmentsResponseTypeMap.put(400, new GenericType(){});
    getCommentAttachmentsResponseTypeMap.put(403, new GenericType(){});
    getCommentAttachmentsResponseTypeMap.put(404, new GenericType(){});
  }

  private static final Map getCommentsResponseTypeMap = new HashMap();
  static {
    getCommentsResponseTypeMap.put(200, new GenericType>(){});
    getCommentsResponseTypeMap.put(400, new GenericType(){});
    getCommentsResponseTypeMap.put(403, new GenericType(){});
    getCommentsResponseTypeMap.put(404, new GenericType(){});
  }

  private static final Map patchCommentResponseTypeMap = new HashMap();

  


  /**
   * Get the API client
   *
   * @return API client
   */
  public ApiClient getApiClient() {
    return apiClient;
  }

  /**
   * Set the API client
   *
   * @param apiClient an instance of API client
   */
  public void setApiClient(ApiClient apiClient) {
    this.apiClient = apiClient;
  }

  /**
   * Create a comment to a Note
   * 
   * @param noteId The note Id to which the comment will be added (required)
   * @param createCommentDto The details of the comment to be created (optional)
   * @return NewItemDto
   * @throws ApiException if fails to make API call
   * @http.response.details
     
Status Code Description Response Headers
201 Created -
400 Bad Request -
403 Forbidden -
404 Not Found -
500 Server Error -
*/ public NewItemDto createComment(java.util.UUID noteId, CreateCommentDto createCommentDto) throws ApiException { return createCommentWithHttpInfo(noteId, createCommentDto).getData(); } /** * Create a comment to a Note * * @param noteId The note Id to which the comment will be added (required) * @param createCommentDto The details of the comment to be created (optional) * @return ApiResponse<NewItemDto> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
201 Created -
400 Bad Request -
403 Forbidden -
404 Not Found -
500 Server Error -
*/ public ApiResponse createCommentWithHttpInfo(java.util.UUID noteId, CreateCommentDto createCommentDto) throws ApiException { Object localVarPostBody = createCommentDto; // verify the required parameter 'noteId' is set if (noteId == null) { throw new ApiException(400, "Missing the required parameter 'noteId' when calling createComment"); } // create path and map variables String localVarPath = "/notes/{noteId}/comments" .replaceAll("\\{" + "noteId" + "\\}", apiClient.escapeString(noteId.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { "application/json-patch+json", "application/json", "text/json", "application/_*+json" }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< NewItemDto > apiResponse = apiClient.invokeAPI("CommentsApi.createComment", localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, createCommentResponseTypeMap, false); return apiResponse; } /** * Create a comment attachment to a Note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @param _file (required) * @return NewItemDto * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
201 Created -
400 Bad Request -
403 Forbidden -
404 Not Found -
500 Server Error -
*/ public NewItemDto createCommentAttachment(java.util.UUID noteId, java.util.UUID commentId, File _file) throws ApiException { return createCommentAttachmentWithHttpInfo(noteId, commentId, _file).getData(); } /** * Create a comment attachment to a Note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @param _file (required) * @return ApiResponse<NewItemDto> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
201 Created -
400 Bad Request -
403 Forbidden -
404 Not Found -
500 Server Error -
*/ public ApiResponse createCommentAttachmentWithHttpInfo(java.util.UUID noteId, java.util.UUID commentId, File _file) throws ApiException { Object localVarPostBody = null; // verify the required parameter 'noteId' is set if (noteId == null) { throw new ApiException(400, "Missing the required parameter 'noteId' when calling createCommentAttachment"); } // verify the required parameter 'commentId' is set if (commentId == null) { throw new ApiException(400, "Missing the required parameter 'commentId' when calling createCommentAttachment"); } // verify the required parameter '_file' is set if (_file == null) { throw new ApiException(400, "Missing the required parameter '_file' when calling createCommentAttachment"); } // create path and map variables String localVarPath = "/notes/{noteId}/comments/{commentId}/attachments" .replaceAll("\\{" + "noteId" + "\\}", apiClient.escapeString(noteId.toString())) .replaceAll("\\{" + "commentId" + "\\}", apiClient.escapeString(commentId.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); if (_file != null) localVarFormParams.put("file", _file); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { "multipart/form-data" }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< NewItemDto > apiResponse = apiClient.invokeAPI("CommentsApi.createCommentAttachment", localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, createCommentAttachmentResponseTypeMap, false); return apiResponse; } /** * Delete a Comment from a Note * * @param noteId The note id from which the comment will be deleted (required) * @param commentId Comment Id (required) * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
403 Forbidden -
404 Not Found -
500 Server Error -
*/ public void deleteComment(java.util.UUID noteId, java.util.UUID commentId) throws ApiException { deleteCommentWithHttpInfo(noteId, commentId); } /** * Delete a Comment from a Note * * @param noteId The note id from which the comment will be deleted (required) * @param commentId Comment Id (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
403 Forbidden -
404 Not Found -
500 Server Error -
*/ public ApiResponse deleteCommentWithHttpInfo(java.util.UUID noteId, java.util.UUID commentId) throws ApiException { Object localVarPostBody = null; // verify the required parameter 'noteId' is set if (noteId == null) { throw new ApiException(400, "Missing the required parameter 'noteId' when calling deleteComment"); } // verify the required parameter 'commentId' is set if (commentId == null) { throw new ApiException(400, "Missing the required parameter 'commentId' when calling deleteComment"); } // create path and map variables String localVarPath = "/notes/{noteId}/comments/{commentId}" .replaceAll("\\{" + "noteId" + "\\}", apiClient.escapeString(noteId.toString())) .replaceAll("\\{" + "commentId" + "\\}", apiClient.escapeString(commentId.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< Void > apiResponse = apiClient.invokeAPI("CommentsApi.deleteComment", localVarPath, "DELETE", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, deleteCommentResponseTypeMap, false); return apiResponse; } /** * Download single attachment detail of a comment belonging to a note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @param attachmentId Attachment Id (required) * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public void downloadCommentAttachmentForComment(java.util.UUID noteId, java.util.UUID commentId, java.util.UUID attachmentId) throws ApiException { downloadCommentAttachmentForCommentWithHttpInfo(noteId, commentId, attachmentId); } /** * Download single attachment detail of a comment belonging to a note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @param attachmentId Attachment Id (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public ApiResponse downloadCommentAttachmentForCommentWithHttpInfo(java.util.UUID noteId, java.util.UUID commentId, java.util.UUID attachmentId) throws ApiException { Object localVarPostBody = null; // verify the required parameter 'noteId' is set if (noteId == null) { throw new ApiException(400, "Missing the required parameter 'noteId' when calling downloadCommentAttachmentForComment"); } // verify the required parameter 'commentId' is set if (commentId == null) { throw new ApiException(400, "Missing the required parameter 'commentId' when calling downloadCommentAttachmentForComment"); } // verify the required parameter 'attachmentId' is set if (attachmentId == null) { throw new ApiException(400, "Missing the required parameter 'attachmentId' when calling downloadCommentAttachmentForComment"); } // create path and map variables String localVarPath = "/notes/{noteId}/comments/{commentId}/attachments/{attachmentId}/download" .replaceAll("\\{" + "noteId" + "\\}", apiClient.escapeString(noteId.toString())) .replaceAll("\\{" + "commentId" + "\\}", apiClient.escapeString(commentId.toString())) .replaceAll("\\{" + "attachmentId" + "\\}", apiClient.escapeString(attachmentId.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< Void > apiResponse = apiClient.invokeAPI("CommentsApi.downloadCommentAttachmentForComment", localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, downloadCommentAttachmentForCommentResponseTypeMap, false); return apiResponse; } /** * Get details of a comment belonging to a note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @return CommentDto * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public CommentDto getComment(java.util.UUID noteId, java.util.UUID commentId) throws ApiException { return getCommentWithHttpInfo(noteId, commentId).getData(); } /** * Get details of a comment belonging to a note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @return ApiResponse<CommentDto> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public ApiResponse getCommentWithHttpInfo(java.util.UUID noteId, java.util.UUID commentId) throws ApiException { Object localVarPostBody = null; // verify the required parameter 'noteId' is set if (noteId == null) { throw new ApiException(400, "Missing the required parameter 'noteId' when calling getComment"); } // verify the required parameter 'commentId' is set if (commentId == null) { throw new ApiException(400, "Missing the required parameter 'commentId' when calling getComment"); } // create path and map variables String localVarPath = "/notes/{noteId}/comments/{commentId}" .replaceAll("\\{" + "noteId" + "\\}", apiClient.escapeString(noteId.toString())) .replaceAll("\\{" + "commentId" + "\\}", apiClient.escapeString(commentId.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< CommentDto > apiResponse = apiClient.invokeAPI("CommentsApi.getComment", localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, getCommentResponseTypeMap, false); return apiResponse; } /** * Get attachments summary of a comment belonging to a note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @return java.util.List * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public java.util.List getCommentAttachments(java.util.UUID noteId, java.util.UUID commentId) throws ApiException { return getCommentAttachmentsWithHttpInfo(noteId, commentId).getData(); } /** * Get attachments summary of a comment belonging to a note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @return ApiResponse<java.util.List> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public ApiResponse> getCommentAttachmentsWithHttpInfo(java.util.UUID noteId, java.util.UUID commentId) throws ApiException { Object localVarPostBody = null; // verify the required parameter 'noteId' is set if (noteId == null) { throw new ApiException(400, "Missing the required parameter 'noteId' when calling getCommentAttachments"); } // verify the required parameter 'commentId' is set if (commentId == null) { throw new ApiException(400, "Missing the required parameter 'commentId' when calling getCommentAttachments"); } // create path and map variables String localVarPath = "/notes/{noteId}/comments/{commentId}/attachments" .replaceAll("\\{" + "noteId" + "\\}", apiClient.escapeString(noteId.toString())) .replaceAll("\\{" + "commentId" + "\\}", apiClient.escapeString(commentId.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< java.util.List > apiResponse = apiClient.invokeAPI("CommentsApi.getCommentAttachments", localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, getCommentAttachmentsResponseTypeMap, false); return apiResponse; } /** * Get all comments for a note * * @param noteId Note Id (required) * @return java.util.List * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public java.util.List getComments(java.util.UUID noteId) throws ApiException { return getCommentsWithHttpInfo(noteId).getData(); } /** * Get all comments for a note * * @param noteId Note Id (required) * @return ApiResponse<java.util.List> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public ApiResponse> getCommentsWithHttpInfo(java.util.UUID noteId) throws ApiException { Object localVarPostBody = null; // verify the required parameter 'noteId' is set if (noteId == null) { throw new ApiException(400, "Missing the required parameter 'noteId' when calling getComments"); } // create path and map variables String localVarPath = "/notes/{noteId}/comments" .replaceAll("\\{" + "noteId" + "\\}", apiClient.escapeString(noteId.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< java.util.List > apiResponse = apiClient.invokeAPI("CommentsApi.getComments", localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, getCommentsResponseTypeMap, false); return apiResponse; } /** * Edit a comment for a note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @param operation The JSON patch document with updates for the comment (optional) * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public void patchComment(java.util.UUID noteId, java.util.UUID commentId, java.util.List operation) throws ApiException { patchCommentWithHttpInfo(noteId, commentId, operation); } /** * Edit a comment for a note * * @param noteId Note Id (required) * @param commentId Comment Id (required) * @param operation The JSON patch document with updates for the comment (optional) * @return ApiResponse<Void> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad Request -
403 Forbidden -
404 Not Found -
*/ public ApiResponse patchCommentWithHttpInfo(java.util.UUID noteId, java.util.UUID commentId, java.util.List operation) throws ApiException { Object localVarPostBody = operation; // verify the required parameter 'noteId' is set if (noteId == null) { throw new ApiException(400, "Missing the required parameter 'noteId' when calling patchComment"); } // verify the required parameter 'commentId' is set if (commentId == null) { throw new ApiException(400, "Missing the required parameter 'commentId' when calling patchComment"); } // create path and map variables String localVarPath = "/notes/{noteId}/comments/{commentId}" .replaceAll("\\{" + "noteId" + "\\}", apiClient.escapeString(noteId.toString())) .replaceAll("\\{" + "commentId" + "\\}", apiClient.escapeString(commentId.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { "application/json-patch+json", "application/json", "text/json", "application/_*+json" }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< Void > apiResponse = apiClient.invokeAPI("CommentsApi.patchComment", localVarPath, "PATCH", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, patchCommentResponseTypeMap, false); return apiResponse; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy