Package org.bonitasoft.web.client.api

Interface ProfessionalContactDataApi

All Superinterfaces:
ApiClient.Api
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.12.0") public interface ProfessionalContactDataApi extends ApiClient.Api

  • Method Details

    • createProfessionalContactData

      ProfessionalContactData createProfessionalContactData(ProfessionalContactData body)
      Create the ProfessionalContactData Create the ProfessionalContactData
      Parameters:
      body - Partial ProfessionalContactData description including the user ID (required)
      Returns:
      ProfessionalContactData

    • createProfessionalContactDataWithHttpInfo

      ApiResponse<ProfessionalContactData> createProfessionalContactDataWithHttpInfo(ProfessionalContactData body)
      Create the ProfessionalContactData Similar to createProfessionalContactData but it also returns the http response headers . Create the ProfessionalContactData
      Parameters:
      body - Partial ProfessionalContactData description including the user ID (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • getPersonalContactDataById

      ProfessionalContactData getPersonalContactDataById(String userId)
      Finds the PersonalContactData by ID Returns the single PersonalContactData for the given ID
      Parameters:
      userId - User ID of the PersonalContactData to return (required)
      Returns:
      ProfessionalContactData

    • getPersonalContactDataByIdWithHttpInfo

      ApiResponse<ProfessionalContactData> getPersonalContactDataByIdWithHttpInfo(String userId)
      Finds the PersonalContactData by ID Similar to getPersonalContactDataById but it also returns the http response headers . Returns the single PersonalContactData for the given ID
      Parameters:
      userId - User ID of the PersonalContactData to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • getProfessionalContactDataById

      ProfessionalContactData getProfessionalContactDataById(String userId)
      Finds the ProfessionalContactData by ID Returns the single ProfessionalContactData for the given ID
      Parameters:
      userId - User ID of the ProfessionalContactData to return (required)
      Returns:
      ProfessionalContactData

    • getProfessionalContactDataByIdWithHttpInfo

      ApiResponse<ProfessionalContactData> getProfessionalContactDataByIdWithHttpInfo(String userId)
      Finds the ProfessionalContactData by ID Similar to getProfessionalContactDataById but it also returns the http response headers . Returns the single ProfessionalContactData for the given ID
      Parameters:
      userId - User ID of the ProfessionalContactData to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchProfessionalContactDatas

      List<ProfessionalContactData> searchProfessionalContactDatas(Integer p, Integer c, List<String> f, String o, String s)
      Finds ProfessionalContactData Finds ProfessionalContactData with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
      Parameters:
      p - index of the page to display (required)
      c - maximum number of elements to retrieve (required)
      f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
      o - can order on attributes (optional)
      s - can search on attributes (optional)
      Returns:
      List<ProfessionalContactData>

    • searchProfessionalContactDatasWithHttpInfo

      ApiResponse<List<ProfessionalContactData>> searchProfessionalContactDatasWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
      Finds ProfessionalContactData Similar to searchProfessionalContactDatas but it also returns the http response headers . Finds ProfessionalContactData with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
      Parameters:
      p - index of the page to display (required)
      c - maximum number of elements to retrieve (required)
      f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
      o - can order on attributes (optional)
      s - can search on attributes (optional)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchProfessionalContactDatas

      List<ProfessionalContactData> searchProfessionalContactDatas(ProfessionalContactDataApi.SearchProfessionalContactDatasQueryParams queryParams)
      Finds ProfessionalContactData Finds ProfessionalContactData with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchProfessionalContactDatas method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the ProfessionalContactDataApi.SearchProfessionalContactDatasQueryParams class that allows for building up this map in a fluent style.
      Parameters:
      queryParams - Map of query parameters as name-value pairs

      The following elements may be specified in the query map:

      • p - index of the page to display (required)
      • c - maximum number of elements to retrieve (required)
      • f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
      • o - can order on attributes (optional)
      • s - can search on attributes (optional)
      Returns:
      List<ProfessionalContactData>

    • searchProfessionalContactDatasWithHttpInfo

      ApiResponse<List<ProfessionalContactData>> searchProfessionalContactDatasWithHttpInfo(ProfessionalContactDataApi.SearchProfessionalContactDatasQueryParams queryParams)
      Finds ProfessionalContactData Finds ProfessionalContactData with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchProfessionalContactDatas that receives the query parameters as a map, but this one also exposes the Http response headers
      Parameters:
      queryParams - Map of query parameters as name-value pairs

      The following elements may be specified in the query map:

      • p - index of the page to display (required)
      • c - maximum number of elements to retrieve (required)
      • f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
      • o - can order on attributes (optional)
      • s - can search on attributes (optional)
      Returns:
      List<ProfessionalContactData>

    • updatePersonalContactDataById

      void updatePersonalContactDataById(String userId, ProfessionalContactData professionalContactData)
      Update the PersonalContactData by ID Update the PersonalContactData for the given ID
      Parameters:
      userId - User ID of the PersonalContactData to update (required)
      professionalContactData - Partial PersonalContactData description including the user ID (required)

    • updatePersonalContactDataByIdWithHttpInfo

      ApiResponse<Void> updatePersonalContactDataByIdWithHttpInfo(String userId, ProfessionalContactData professionalContactData)
      Update the PersonalContactData by ID Similar to updatePersonalContactDataById but it also returns the http response headers . Update the PersonalContactData for the given ID
      Parameters:
      userId - User ID of the PersonalContactData to update (required)
      professionalContactData - Partial PersonalContactData description including the user ID (required)

    • updateProfessionalContactDataById

      void updateProfessionalContactDataById(String userId, ProfessionalContactData professionalContactData)
      Update the ProfessionalContactData by ID Update the ProfessionalContactData for the given ID
      Parameters:
      userId - User ID of the ProfessionalContactData to update (required)
      professionalContactData - Partial ProfessionalContactData description including the user ID (required)

    • updateProfessionalContactDataByIdWithHttpInfo

      ApiResponse<Void> updateProfessionalContactDataByIdWithHttpInfo(String userId, ProfessionalContactData professionalContactData)
      Update the ProfessionalContactData by ID Similar to updateProfessionalContactDataById but it also returns the http response headers . Update the ProfessionalContactData for the given ID
      Parameters:
      userId - User ID of the ProfessionalContactData to update (required)
      professionalContactData - Partial ProfessionalContactData description including the user ID (required)