Package com.mypurecloud.sdk.v2.api

Class CoachingApi

java.lang.Object
com.mypurecloud.sdk.v2.api.CoachingApi
public class CoachingApi extends Object

  • Constructor Details

    • CoachingApi

      public CoachingApi()

    • CoachingApi

      public CoachingApi(ApiClient apiClient)

  • Method Details

    • deleteCoachingAppointment

      public CoachingAppointmentReference deleteCoachingAppointment(String appointmentId) throws IOException, ApiException
      Delete an existing appointment Permission not required if you are the creator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      Returns:
      CoachingAppointmentReference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCoachingAppointmentWithHttpInfo

      public ApiResponse<CoachingAppointmentReference> deleteCoachingAppointmentWithHttpInfo(String appointmentId) throws IOException
      Delete an existing appointment Permission not required if you are the creator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      Returns:
      CoachingAppointmentReference
      Throws:
      IOException - if the request fails to be processed

    • deleteCoachingAppointment

      public CoachingAppointmentReference deleteCoachingAppointment(DeleteCoachingAppointmentRequest request) throws IOException, ApiException
      Delete an existing appointment Permission not required if you are the creator of the appointment
      Parameters:
      request - The request object
      Returns:
      CoachingAppointmentReference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCoachingAppointment

      public ApiResponse<CoachingAppointmentReference> deleteCoachingAppointment(ApiRequest<Void> request) throws IOException
      Delete an existing appointment Permission not required if you are the creator of the appointment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteCoachingAppointmentAnnotation

      public void deleteCoachingAppointmentAnnotation(String appointmentId, String annotationId) throws IOException, ApiException
      Delete an existing annotation You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      annotationId - The ID of the annotation. (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCoachingAppointmentAnnotationWithHttpInfo

      public ApiResponse<Void> deleteCoachingAppointmentAnnotationWithHttpInfo(String appointmentId, String annotationId) throws IOException
      Delete an existing annotation You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      annotationId - The ID of the annotation. (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteCoachingAppointmentAnnotation

      public void deleteCoachingAppointmentAnnotation(DeleteCoachingAppointmentAnnotationRequest request) throws IOException, ApiException
      Delete an existing annotation You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteCoachingAppointmentAnnotation

      public ApiResponse<Void> deleteCoachingAppointmentAnnotation(ApiRequest<Void> request) throws IOException
      Delete an existing annotation You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointment

      public CoachingAppointmentResponse getCoachingAppointment(String appointmentId) throws IOException, ApiException
      Retrieve an appointment Permission not required if you are the attendee, creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      Returns:
      CoachingAppointmentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentWithHttpInfo

      public ApiResponse<CoachingAppointmentResponse> getCoachingAppointmentWithHttpInfo(String appointmentId) throws IOException
      Retrieve an appointment Permission not required if you are the attendee, creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      Returns:
      CoachingAppointmentResponse
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointment

      public CoachingAppointmentResponse getCoachingAppointment(GetCoachingAppointmentRequest request) throws IOException, ApiException
      Retrieve an appointment Permission not required if you are the attendee, creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      CoachingAppointmentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointment

      public ApiResponse<CoachingAppointmentResponse> getCoachingAppointment(ApiRequest<Void> request) throws IOException
      Retrieve an appointment Permission not required if you are the attendee, creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointmentAnnotation

      public CoachingAnnotation getCoachingAppointmentAnnotation(String appointmentId, String annotationId) throws IOException, ApiException
      Retrieve an annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      annotationId - The ID of the annotation. (required)
      Returns:
      CoachingAnnotation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentAnnotationWithHttpInfo

      public ApiResponse<CoachingAnnotation> getCoachingAppointmentAnnotationWithHttpInfo(String appointmentId, String annotationId) throws IOException
      Retrieve an annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      annotationId - The ID of the annotation. (required)
      Returns:
      CoachingAnnotation
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointmentAnnotation

      public CoachingAnnotation getCoachingAppointmentAnnotation(GetCoachingAppointmentAnnotationRequest request) throws IOException, ApiException
      Retrieve an annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
      Parameters:
      request - The request object
      Returns:
      CoachingAnnotation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentAnnotation

      public ApiResponse<CoachingAnnotation> getCoachingAppointmentAnnotation(ApiRequest<Void> request) throws IOException
      Retrieve an annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointmentAnnotations

      public CoachingAnnotationList getCoachingAppointmentAnnotations(String appointmentId, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Get a list of annotations. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      CoachingAnnotationList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentAnnotationsWithHttpInfo

      public ApiResponse<CoachingAnnotationList> getCoachingAppointmentAnnotationsWithHttpInfo(String appointmentId, Integer pageNumber, Integer pageSize) throws IOException
      Get a list of annotations. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      CoachingAnnotationList
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointmentAnnotations

      public CoachingAnnotationList getCoachingAppointmentAnnotations(GetCoachingAppointmentAnnotationsRequest request) throws IOException, ApiException
      Get a list of annotations. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
      Parameters:
      request - The request object
      Returns:
      CoachingAnnotationList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentAnnotations

      public ApiResponse<CoachingAnnotationList> getCoachingAppointmentAnnotations(ApiRequest<Void> request) throws IOException
      Get a list of annotations. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointmentStatuses

      public CoachingAppointmentStatusResponseList getCoachingAppointmentStatuses(String appointmentId, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Get the list of status changes for a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      CoachingAppointmentStatusResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentStatusesWithHttpInfo

      public ApiResponse<CoachingAppointmentStatusResponseList> getCoachingAppointmentStatusesWithHttpInfo(String appointmentId, Integer pageNumber, Integer pageSize) throws IOException
      Get the list of status changes for a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      CoachingAppointmentStatusResponseList
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointmentStatuses

      public CoachingAppointmentStatusResponseList getCoachingAppointmentStatuses(GetCoachingAppointmentStatusesRequest request) throws IOException, ApiException
      Get the list of status changes for a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      CoachingAppointmentStatusResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentStatuses

      public ApiResponse<CoachingAppointmentStatusResponseList> getCoachingAppointmentStatuses(ApiRequest<Void> request) throws IOException
      Get the list of status changes for a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointments

      public CoachingAppointmentResponseList getCoachingAppointments(List<String> userIds, String interval, Integer pageNumber, Integer pageSize, List<String> statuses, List<String> facilitatorIds, String sortOrder, List<String> relationships, String completionInterval, String overdue, String intervalCondition) throws IOException, ApiException
      Get appointments for users and optional date range
      Parameters:
      userIds - The user IDs for which to retrieve appointments (required)
      interval - Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      statuses - Appointment Statuses to filter by (optional)
      facilitatorIds - The facilitator IDs for which to retrieve appointments (optional)
      sortOrder - Sort (by due date) either Asc or Desc (optional)
      relationships - Relationships to filter by (optional)
      completionInterval - Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      overdue - Overdue status to filter by (optional)
      intervalCondition - Filter condition for interval (optional)
      Returns:
      CoachingAppointmentResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentsWithHttpInfo

      public ApiResponse<CoachingAppointmentResponseList> getCoachingAppointmentsWithHttpInfo(List<String> userIds, String interval, Integer pageNumber, Integer pageSize, List<String> statuses, List<String> facilitatorIds, String sortOrder, List<String> relationships, String completionInterval, String overdue, String intervalCondition) throws IOException
      Get appointments for users and optional date range
      Parameters:
      userIds - The user IDs for which to retrieve appointments (required)
      interval - Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      statuses - Appointment Statuses to filter by (optional)
      facilitatorIds - The facilitator IDs for which to retrieve appointments (optional)
      sortOrder - Sort (by due date) either Asc or Desc (optional)
      relationships - Relationships to filter by (optional)
      completionInterval - Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      overdue - Overdue status to filter by (optional)
      intervalCondition - Filter condition for interval (optional)
      Returns:
      CoachingAppointmentResponseList
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointments

      public CoachingAppointmentResponseList getCoachingAppointments(GetCoachingAppointmentsRequest request) throws IOException, ApiException
      Get appointments for users and optional date range
      Parameters:
      request - The request object
      Returns:
      CoachingAppointmentResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointments

      public ApiResponse<CoachingAppointmentResponseList> getCoachingAppointments(ApiRequest<Void> request) throws IOException
      Get appointments for users and optional date range
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointmentsMe

      public CoachingAppointmentResponseList getCoachingAppointmentsMe(String interval, Integer pageNumber, Integer pageSize, List<String> statuses, List<String> facilitatorIds, String sortOrder, List<String> relationships, String completionInterval, String overdue, String intervalCondition) throws IOException, ApiException
      Get my appointments for a given date range
      Parameters:
      interval - Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      statuses - Appointment Statuses to filter by (optional)
      facilitatorIds - The facilitator IDs for which to retrieve appointments (optional)
      sortOrder - Sort (by due date) either Asc or Desc (optional)
      relationships - Relationships to filter by (optional)
      completionInterval - Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      overdue - Overdue status to filter by (optional)
      intervalCondition - Filter condition for interval (optional)
      Returns:
      CoachingAppointmentResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentsMeWithHttpInfo

      public ApiResponse<CoachingAppointmentResponseList> getCoachingAppointmentsMeWithHttpInfo(String interval, Integer pageNumber, Integer pageSize, List<String> statuses, List<String> facilitatorIds, String sortOrder, List<String> relationships, String completionInterval, String overdue, String intervalCondition) throws IOException
      Get my appointments for a given date range
      Parameters:
      interval - Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      statuses - Appointment Statuses to filter by (optional)
      facilitatorIds - The facilitator IDs for which to retrieve appointments (optional)
      sortOrder - Sort (by due date) either Asc or Desc (optional)
      relationships - Relationships to filter by (optional)
      completionInterval - Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
      overdue - Overdue status to filter by (optional)
      intervalCondition - Filter condition for interval (optional)
      Returns:
      CoachingAppointmentResponseList
      Throws:
      IOException - if the request fails to be processed

    • getCoachingAppointmentsMe

      public CoachingAppointmentResponseList getCoachingAppointmentsMe(GetCoachingAppointmentsMeRequest request) throws IOException, ApiException
      Get my appointments for a given date range
      Parameters:
      request - The request object
      Returns:
      CoachingAppointmentResponseList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingAppointmentsMe

      public ApiResponse<CoachingAppointmentResponseList> getCoachingAppointmentsMe(ApiRequest<Void> request) throws IOException
      Get my appointments for a given date range
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCoachingNotification

      public CoachingNotification getCoachingNotification(String notificationId, List<String> expand) throws IOException, ApiException
      Get an existing notification Permission not required if you are the owner of the notification.
      Parameters:
      notificationId - The ID of the notification. (required)
      expand - Indicates a field in the response which should be expanded. (optional)
      Returns:
      CoachingNotification
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingNotificationWithHttpInfo

      public ApiResponse<CoachingNotification> getCoachingNotificationWithHttpInfo(String notificationId, List<String> expand) throws IOException
      Get an existing notification Permission not required if you are the owner of the notification.
      Parameters:
      notificationId - The ID of the notification. (required)
      expand - Indicates a field in the response which should be expanded. (optional)
      Returns:
      CoachingNotification
      Throws:
      IOException - if the request fails to be processed

    • getCoachingNotification

      public CoachingNotification getCoachingNotification(GetCoachingNotificationRequest request) throws IOException, ApiException
      Get an existing notification Permission not required if you are the owner of the notification.
      Parameters:
      request - The request object
      Returns:
      CoachingNotification
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingNotification

      public ApiResponse<CoachingNotification> getCoachingNotification(ApiRequest<Void> request) throws IOException
      Get an existing notification Permission not required if you are the owner of the notification.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCoachingNotifications

      public CoachingNotificationList getCoachingNotifications(Integer pageNumber, Integer pageSize, List<String> expand) throws IOException, ApiException
      Retrieve the list of your notifications.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      expand - Indicates a field in the response which should be expanded. (optional)
      Returns:
      CoachingNotificationList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingNotificationsWithHttpInfo

      public ApiResponse<CoachingNotificationList> getCoachingNotificationsWithHttpInfo(Integer pageNumber, Integer pageSize, List<String> expand) throws IOException
      Retrieve the list of your notifications.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      expand - Indicates a field in the response which should be expanded. (optional)
      Returns:
      CoachingNotificationList
      Throws:
      IOException - if the request fails to be processed

    • getCoachingNotifications

      public CoachingNotificationList getCoachingNotifications(GetCoachingNotificationsRequest request) throws IOException, ApiException
      Retrieve the list of your notifications.
      Parameters:
      request - The request object
      Returns:
      CoachingNotificationList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingNotifications

      public ApiResponse<CoachingNotificationList> getCoachingNotifications(ApiRequest<Void> request) throws IOException
      Retrieve the list of your notifications.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getCoachingScheduleslotsJob

      public CoachingScheduleSlotsJobResponse getCoachingScheduleslotsJob(String jobId) throws IOException, ApiException
      Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
      Parameters:
      jobId - The ID of job (required)
      Returns:
      CoachingScheduleSlotsJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingScheduleslotsJobWithHttpInfo

      public ApiResponse<CoachingScheduleSlotsJobResponse> getCoachingScheduleslotsJobWithHttpInfo(String jobId) throws IOException
      Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
      Parameters:
      jobId - The ID of job (required)
      Returns:
      CoachingScheduleSlotsJobResponse
      Throws:
      IOException - if the request fails to be processed

    • getCoachingScheduleslotsJob

      public CoachingScheduleSlotsJobResponse getCoachingScheduleslotsJob(GetCoachingScheduleslotsJobRequest request) throws IOException, ApiException
      Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
      Parameters:
      request - The request object
      Returns:
      CoachingScheduleSlotsJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getCoachingScheduleslotsJob

      public ApiResponse<CoachingScheduleSlotsJobResponse> getCoachingScheduleslotsJob(ApiRequest<Void> request) throws IOException
      Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCoachingAppointment

      public CoachingAppointmentResponse patchCoachingAppointment(String appointmentId, UpdateCoachingAppointmentRequest body) throws IOException, ApiException
      Update an existing appointment Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      body - The new version of the appointment (required)
      Returns:
      CoachingAppointmentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCoachingAppointmentWithHttpInfo

      public ApiResponse<CoachingAppointmentResponse> patchCoachingAppointmentWithHttpInfo(String appointmentId, UpdateCoachingAppointmentRequest body) throws IOException
      Update an existing appointment Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      body - The new version of the appointment (required)
      Returns:
      CoachingAppointmentResponse
      Throws:
      IOException - if the request fails to be processed

    • patchCoachingAppointment

      public CoachingAppointmentResponse patchCoachingAppointment(PatchCoachingAppointmentRequest request) throws IOException, ApiException
      Update an existing appointment Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      CoachingAppointmentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCoachingAppointment

      public ApiResponse<CoachingAppointmentResponse> patchCoachingAppointment(ApiRequest<UpdateCoachingAppointmentRequest> request) throws IOException
      Update an existing appointment Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCoachingAppointmentAnnotation

      public CoachingAnnotation patchCoachingAppointmentAnnotation(String appointmentId, String annotationId, CoachingAnnotation body) throws IOException, ApiException
      Update an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      annotationId - The ID of the annotation. (required)
      body - The new version of the annotation (required)
      Returns:
      CoachingAnnotation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCoachingAppointmentAnnotationWithHttpInfo

      public ApiResponse<CoachingAnnotation> patchCoachingAppointmentAnnotationWithHttpInfo(String appointmentId, String annotationId, CoachingAnnotation body) throws IOException
      Update an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      annotationId - The ID of the annotation. (required)
      body - The new version of the annotation (required)
      Returns:
      CoachingAnnotation
      Throws:
      IOException - if the request fails to be processed

    • patchCoachingAppointmentAnnotation

      public CoachingAnnotation patchCoachingAppointmentAnnotation(PatchCoachingAppointmentAnnotationRequest request) throws IOException, ApiException
      Update an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      CoachingAnnotation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCoachingAppointmentAnnotation

      public ApiResponse<CoachingAnnotation> patchCoachingAppointmentAnnotation(ApiRequest<CoachingAnnotation> request) throws IOException
      Update an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCoachingAppointmentStatus

      public CoachingAppointmentStatusResponse patchCoachingAppointmentStatus(String appointmentId, CoachingAppointmentStatusRequest body) throws IOException, ApiException
      Update the status of a coaching appointment Permission not required if you are an attendee, creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      body - Updated status of the coaching appointment (required)
      Returns:
      CoachingAppointmentStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCoachingAppointmentStatusWithHttpInfo

      public ApiResponse<CoachingAppointmentStatusResponse> patchCoachingAppointmentStatusWithHttpInfo(String appointmentId, CoachingAppointmentStatusRequest body) throws IOException
      Update the status of a coaching appointment Permission not required if you are an attendee, creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      body - Updated status of the coaching appointment (required)
      Returns:
      CoachingAppointmentStatusResponse
      Throws:
      IOException - if the request fails to be processed

    • patchCoachingAppointmentStatus

      public CoachingAppointmentStatusResponse patchCoachingAppointmentStatus(PatchCoachingAppointmentStatusRequest request) throws IOException, ApiException
      Update the status of a coaching appointment Permission not required if you are an attendee, creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      CoachingAppointmentStatusResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCoachingAppointmentStatus

      public ApiResponse<CoachingAppointmentStatusResponse> patchCoachingAppointmentStatus(ApiRequest<CoachingAppointmentStatusRequest> request) throws IOException
      Update the status of a coaching appointment Permission not required if you are an attendee, creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchCoachingNotification

      public CoachingNotification patchCoachingNotification(String notificationId, CoachingNotification body) throws IOException, ApiException
      Update an existing notification. Can only update your own notifications.
      Parameters:
      notificationId - The ID of the notification. (required)
      body - Change the read state of a notification (required)
      Returns:
      CoachingNotification
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCoachingNotificationWithHttpInfo

      public ApiResponse<CoachingNotification> patchCoachingNotificationWithHttpInfo(String notificationId, CoachingNotification body) throws IOException
      Update an existing notification. Can only update your own notifications.
      Parameters:
      notificationId - The ID of the notification. (required)
      body - Change the read state of a notification (required)
      Returns:
      CoachingNotification
      Throws:
      IOException - if the request fails to be processed

    • patchCoachingNotification

      public CoachingNotification patchCoachingNotification(PatchCoachingNotificationRequest request) throws IOException, ApiException
      Update an existing notification. Can only update your own notifications.
      Parameters:
      request - The request object
      Returns:
      CoachingNotification
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchCoachingNotification

      public ApiResponse<CoachingNotification> patchCoachingNotification(ApiRequest<CoachingNotification> request) throws IOException
      Update an existing notification. Can only update your own notifications.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCoachingAppointmentAnnotations

      public CoachingAnnotation postCoachingAppointmentAnnotations(String appointmentId, CoachingAnnotationCreateRequest body) throws IOException, ApiException
      Create a new annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      body - The annotation to add (required)
      Returns:
      CoachingAnnotation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingAppointmentAnnotationsWithHttpInfo

      public ApiResponse<CoachingAnnotation> postCoachingAppointmentAnnotationsWithHttpInfo(String appointmentId, CoachingAnnotationCreateRequest body) throws IOException
      Create a new annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      body - The annotation to add (required)
      Returns:
      CoachingAnnotation
      Throws:
      IOException - if the request fails to be processed

    • postCoachingAppointmentAnnotations

      public CoachingAnnotation postCoachingAppointmentAnnotations(PostCoachingAppointmentAnnotationsRequest request) throws IOException, ApiException
      Create a new annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).
      Parameters:
      request - The request object
      Returns:
      CoachingAnnotation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingAppointmentAnnotations

      public ApiResponse<CoachingAnnotation> postCoachingAppointmentAnnotations(ApiRequest<CoachingAnnotationCreateRequest> request) throws IOException
      Create a new annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCoachingAppointmentConversations

      public AddConversationResponse postCoachingAppointmentConversations(String appointmentId, AddConversationRequest body) throws IOException, ApiException
      Add a conversation to an appointment Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      body - body (required)
      Returns:
      AddConversationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingAppointmentConversationsWithHttpInfo

      public ApiResponse<AddConversationResponse> postCoachingAppointmentConversationsWithHttpInfo(String appointmentId, AddConversationRequest body) throws IOException
      Add a conversation to an appointment Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      appointmentId - The ID of the coaching appointment. (required)
      body - body (required)
      Returns:
      AddConversationResponse
      Throws:
      IOException - if the request fails to be processed

    • postCoachingAppointmentConversations

      public AddConversationResponse postCoachingAppointmentConversations(PostCoachingAppointmentConversationsRequest request) throws IOException, ApiException
      Add a conversation to an appointment Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      AddConversationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingAppointmentConversations

      public ApiResponse<AddConversationResponse> postCoachingAppointmentConversations(ApiRequest<AddConversationRequest> request) throws IOException
      Add a conversation to an appointment Permission not required if you are the creator or facilitator of the appointment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCoachingAppointments

      public CoachingAppointmentResponse postCoachingAppointments(CreateCoachingAppointmentRequest body) throws IOException, ApiException
      Create a new appointment
      Parameters:
      body - The appointment to add (required)
      Returns:
      CoachingAppointmentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingAppointmentsWithHttpInfo

      public ApiResponse<CoachingAppointmentResponse> postCoachingAppointmentsWithHttpInfo(CreateCoachingAppointmentRequest body) throws IOException
      Create a new appointment
      Parameters:
      body - The appointment to add (required)
      Returns:
      CoachingAppointmentResponse
      Throws:
      IOException - if the request fails to be processed

    • postCoachingAppointments

      public CoachingAppointmentResponse postCoachingAppointments(PostCoachingAppointmentsRequest request) throws IOException, ApiException
      Create a new appointment
      Parameters:
      request - The request object
      Returns:
      CoachingAppointmentResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingAppointments

      public ApiResponse<CoachingAppointmentResponse> postCoachingAppointments(ApiRequest<CreateCoachingAppointmentRequest> request) throws IOException
      Create a new appointment
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCoachingAppointmentsAggregatesQuery

      public CoachingAppointmentAggregateResponse postCoachingAppointmentsAggregatesQuery(CoachingAppointmentAggregateRequest body) throws IOException, ApiException
      Retrieve aggregated appointment data
      Parameters:
      body - Aggregate Request (required)
      Returns:
      CoachingAppointmentAggregateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingAppointmentsAggregatesQueryWithHttpInfo

      public ApiResponse<CoachingAppointmentAggregateResponse> postCoachingAppointmentsAggregatesQueryWithHttpInfo(CoachingAppointmentAggregateRequest body) throws IOException
      Retrieve aggregated appointment data
      Parameters:
      body - Aggregate Request (required)
      Returns:
      CoachingAppointmentAggregateResponse
      Throws:
      IOException - if the request fails to be processed

    • postCoachingAppointmentsAggregatesQuery

      public CoachingAppointmentAggregateResponse postCoachingAppointmentsAggregatesQuery(PostCoachingAppointmentsAggregatesQueryRequest request) throws IOException, ApiException
      Retrieve aggregated appointment data
      Parameters:
      request - The request object
      Returns:
      CoachingAppointmentAggregateResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingAppointmentsAggregatesQuery

      public ApiResponse<CoachingAppointmentAggregateResponse> postCoachingAppointmentsAggregatesQuery(ApiRequest<CoachingAppointmentAggregateRequest> request) throws IOException
      Retrieve aggregated appointment data
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCoachingScheduleslotsJobs

      public CoachingScheduleSlotsJobResponse postCoachingScheduleslotsJobs(CoachingScheduleSlotsJobRequest body) throws IOException, ApiException
      Start job to retrieve the slots where a coaching appointment can be scheduled.
      Parameters:
      body - The slots search request (required)
      Returns:
      CoachingScheduleSlotsJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingScheduleslotsJobsWithHttpInfo

      public ApiResponse<CoachingScheduleSlotsJobResponse> postCoachingScheduleslotsJobsWithHttpInfo(CoachingScheduleSlotsJobRequest body) throws IOException
      Start job to retrieve the slots where a coaching appointment can be scheduled.
      Parameters:
      body - The slots search request (required)
      Returns:
      CoachingScheduleSlotsJobResponse
      Throws:
      IOException - if the request fails to be processed

    • postCoachingScheduleslotsJobs

      public CoachingScheduleSlotsJobResponse postCoachingScheduleslotsJobs(PostCoachingScheduleslotsJobsRequest request) throws IOException, ApiException
      Start job to retrieve the slots where a coaching appointment can be scheduled.
      Parameters:
      request - The request object
      Returns:
      CoachingScheduleSlotsJobResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingScheduleslotsJobs

      public ApiResponse<CoachingScheduleSlotsJobResponse> postCoachingScheduleslotsJobs(ApiRequest<CoachingScheduleSlotsJobRequest> request) throws IOException
      Start job to retrieve the slots where a coaching appointment can be scheduled.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postCoachingScheduleslotsQuery

      public CoachingSlotsResponse postCoachingScheduleslotsQuery(CoachingSlotsRequest body) throws IOException, ApiException
      Get list of possible slots where a coaching appointment can be scheduled.
      Parameters:
      body - The slot search request (required)
      Returns:
      CoachingSlotsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingScheduleslotsQueryWithHttpInfo

      public ApiResponse<CoachingSlotsResponse> postCoachingScheduleslotsQueryWithHttpInfo(CoachingSlotsRequest body) throws IOException
      Get list of possible slots where a coaching appointment can be scheduled.
      Parameters:
      body - The slot search request (required)
      Returns:
      CoachingSlotsResponse
      Throws:
      IOException - if the request fails to be processed

    • postCoachingScheduleslotsQuery

      public CoachingSlotsResponse postCoachingScheduleslotsQuery(PostCoachingScheduleslotsQueryRequest request) throws IOException, ApiException
      Get list of possible slots where a coaching appointment can be scheduled.
      Parameters:
      request - The request object
      Returns:
      CoachingSlotsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postCoachingScheduleslotsQuery

      public ApiResponse<CoachingSlotsResponse> postCoachingScheduleslotsQuery(ApiRequest<CoachingSlotsRequest> request) throws IOException
      Get list of possible slots where a coaching appointment can be scheduled.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed