Package com.mypurecloud.sdk.v2.api

Class AIStudioApi

java.lang.Object

com.mypurecloud.sdk.v2.api.AIStudioApi

public class AIStudioApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AIStudioApi()
AIStudioApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteConversationsSummariesSetting(DeleteConversationsSummariesSettingRequest request)	Delete a summary setting.
ApiResponse<Void>	deleteConversationsSummariesSetting(ApiRequest<Void> request)	Delete a summary setting.
void	deleteConversationsSummariesSetting(String summarySettingId)	Delete a summary setting.
ApiResponse<Void>	deleteConversationsSummariesSettingWithHttpInfo(String summarySettingId)	Delete a summary setting.
GuideJob	deleteGuideJobs(DeleteGuideJobsRequest request)	Start the deletion of a guide.
ApiResponse<GuideJob>	deleteGuideJobs(ApiRequest<Void> request)	Start the deletion of a guide.
GuideJob	deleteGuideJobs(String guideId)	Start the deletion of a guide.
ApiResponse<GuideJob>	deleteGuideJobsWithHttpInfo(String guideId)	Start the deletion of a guide.
SummarySetting	getConversationsSummariesSetting(GetConversationsSummariesSettingRequest request)	Receive a summary setting.
ApiResponse<SummarySetting>	getConversationsSummariesSetting(ApiRequest<Void> request)	Receive a summary setting.
SummarySetting	getConversationsSummariesSetting(String summarySettingId)	Receive a summary setting.
SummarySettingEntityListing	getConversationsSummariesSettings(GetConversationsSummariesSettingsRequest request)	Get all summary settings.
ApiResponse<SummarySettingEntityListing>	getConversationsSummariesSettings(ApiRequest<Void> request)	Get all summary settings.
SummarySettingEntityListing	getConversationsSummariesSettings(Integer pageNumber, Integer pageSize, String name, String sortOrder, String language, String sortBy)	Get all summary settings.
ApiResponse<SummarySettingEntityListing>	getConversationsSummariesSettingsWithHttpInfo(Integer pageNumber, Integer pageSize, String name, String sortOrder, String language, String sortBy)	Get all summary settings.
ApiResponse<SummarySetting>	getConversationsSummariesSettingWithHttpInfo(String summarySettingId)	Receive a summary setting.
Guide	getGuide(GetGuideRequest request)	Get guide.
ApiResponse<Guide>	getGuide(ApiRequest<Void> request)	Get guide.
Guide	getGuide(String guideId)	Get guide.
GuideJob	getGuideJob(GetGuideJobRequest request)	Get the specified guide deletion job.
ApiResponse<GuideJob>	getGuideJob(ApiRequest<Void> request)	Get the specified guide deletion job.
GuideJob	getGuideJob(String guideId, String jobId)	Get the specified guide deletion job.
ApiResponse<GuideJob>	getGuideJobWithHttpInfo(String guideId, String jobId)	Get the specified guide deletion job.
GuideEntityListing	getGuides(GetGuidesRequest request)	Get all guides.
ApiResponse<GuideEntityListing>	getGuides(ApiRequest<Void> request)	Get all guides.
GuideEntityListing	getGuides(String name, String nameContains, String status, String sortBy, String sortOrder, Integer pageNumber, Integer pageSize)	Get all guides.
GuideContentGenerationJob	getGuidesJob(GetGuidesJobRequest request)	Get the status of the guide content generation job.
ApiResponse<GuideContentGenerationJob>	getGuidesJob(ApiRequest<Void> request)	Get the status of the guide content generation job.
GuideContentGenerationJob	getGuidesJob(String jobId)	Get the status of the guide content generation job.
ApiResponse<GuideContentGenerationJob>	getGuidesJobWithHttpInfo(String jobId)	Get the status of the guide content generation job.
ApiResponse<GuideEntityListing>	getGuidesWithHttpInfo(String name, String nameContains, String status, String sortBy, String sortOrder, Integer pageNumber, Integer pageSize)	Get all guides.
GuideVersion	getGuideVersion(GetGuideVersionRequest request)	Get a guide version.
ApiResponse<GuideVersion>	getGuideVersion(ApiRequest<Void> request)	Get a guide version.
GuideVersion	getGuideVersion(String guideId, String versionId)	Get a guide version.
GuideVersionPublishJob	getGuideVersionJob(GetGuideVersionJobRequest request)	Get the status of the publishing job for this guide version.
ApiResponse<GuideVersionPublishJob>	getGuideVersionJob(ApiRequest<Void> request)	Get the status of the publishing job for this guide version.
GuideVersionPublishJob	getGuideVersionJob(String guideId, String versionId, String jobId)	Get the status of the publishing job for this guide version.
ApiResponse<GuideVersionPublishJob>	getGuideVersionJobWithHttpInfo(String guideId, String versionId, String jobId)	Get the status of the publishing job for this guide version.
ApiResponse<GuideVersion>	getGuideVersionWithHttpInfo(String guideId, String versionId)	Get a guide version.
ApiResponse<Guide>	getGuideWithHttpInfo(String guideId)	Get guide.
Guide	patchGuide(PatchGuideRequest request)	Update a guide.
ApiResponse<Guide>	patchGuide(ApiRequest<UpdateGuide> request)	Update a guide.
Guide	patchGuide(String guideId, UpdateGuide body)	Update a guide.
GuideVersion	patchGuideVersion(PatchGuideVersionRequest request)	Update a guide version.
ApiResponse<GuideVersion>	patchGuideVersion(ApiRequest<UpdateGuideVersion> request)	Update a guide version.
GuideVersion	patchGuideVersion(String guideId, String versionId, UpdateGuideVersion body)	Update a guide version.
ApiResponse<GuideVersion>	patchGuideVersionWithHttpInfo(String guideId, String versionId, UpdateGuideVersion body)	Update a guide version.
ApiResponse<Guide>	patchGuideWithHttpInfo(String guideId, UpdateGuide body)	Update a guide.
void	postConversationsSummariesPreview(PostConversationsSummariesPreviewRequest request)	Trigger summary preview event generation.
ApiResponse<Void>	postConversationsSummariesPreview(ApiRequest<SummarySettingWithTranscript> request)	Trigger summary preview event generation.
void	postConversationsSummariesPreview(SummarySettingWithTranscript body)	Trigger summary preview event generation.
ApiResponse<Void>	postConversationsSummariesPreviewWithHttpInfo(SummarySettingWithTranscript body)	Trigger summary preview event generation.
SummarySetting	postConversationsSummariesSettings(PostConversationsSummariesSettingsRequest request)	Create a summary setting.
ApiResponse<SummarySetting>	postConversationsSummariesSettings(ApiRequest<SummarySetting> request)	Create a summary setting.
SummarySetting	postConversationsSummariesSettings(SummarySetting body)	Create a summary setting.
ApiResponse<SummarySetting>	postConversationsSummariesSettingsWithHttpInfo(SummarySetting body)	Create a summary setting.
Guide	postGuides(PostGuidesRequest request)	Create a guide.
ApiResponse<Guide>	postGuides(ApiRequest<CreateGuide> request)	Create a guide.
Guide	postGuides(CreateGuide body)	Create a guide.
GuideSessionTurnResponse	postGuideSessionTurns(PostGuideSessionTurnsRequest request)	Add a turn to a guide session.
ApiResponse<GuideSessionTurnResponse>	postGuideSessionTurns(ApiRequest<GuideSessionTurnRequest> request)	Add a turn to a guide session.
GuideSessionTurnResponse	postGuideSessionTurns(String guideId, String guideSessionId, GuideSessionTurnRequest body)	Add a turn to a guide session.
ApiResponse<GuideSessionTurnResponse>	postGuideSessionTurnsWithHttpInfo(String guideId, String guideSessionId, GuideSessionTurnRequest body)	Add a turn to a guide session.
GuideContentGenerationJob	postGuidesJobs(PostGuidesJobsRequest request)	Start a guide content generation job.
ApiResponse<GuideContentGenerationJob>	postGuidesJobs(ApiRequest<GenerateGuideContentRequest> request)	Start a guide content generation job.
GuideContentGenerationJob	postGuidesJobs(GenerateGuideContentRequest body)	Start a guide content generation job.
ApiResponse<GuideContentGenerationJob>	postGuidesJobsWithHttpInfo(GenerateGuideContentRequest body)	Start a guide content generation job.
UploadUrlResponse	postGuidesUploads(PostGuidesUploadsRequest request)	Generate presigned URL for uploading a file content to generate guide
ApiResponse<UploadUrlResponse>	postGuidesUploads(ApiRequest<UploadUrlRequest> request)	Generate presigned URL for uploading a file content to generate guide
UploadUrlResponse	postGuidesUploads(UploadUrlRequest body)	Generate presigned URL for uploading a file content to generate guide
ApiResponse<UploadUrlResponse>	postGuidesUploadsWithHttpInfo(UploadUrlRequest body)	Generate presigned URL for uploading a file content to generate guide
ApiResponse<Guide>	postGuidesWithHttpInfo(CreateGuide body)	Create a guide.
GuideVersionPublishJob	postGuideVersionJobs(PostGuideVersionJobsRequest request)	Start the publishing of a guide version.
ApiResponse<GuideVersionPublishJob>	postGuideVersionJobs(ApiRequest<GuideVersionPublishJobRequest> request)	Start the publishing of a guide version.
GuideVersionPublishJob	postGuideVersionJobs(String guideId, String versionId, GuideVersionPublishJobRequest body)	Start the publishing of a guide version.
ApiResponse<GuideVersionPublishJob>	postGuideVersionJobsWithHttpInfo(String guideId, String versionId, GuideVersionPublishJobRequest body)	Start the publishing of a guide version.
GuideVersion	postGuideVersions(PostGuideVersionsRequest request)	Create a guide version.
ApiResponse<GuideVersion>	postGuideVersions(ApiRequest<CreateGuideVersion> request)	Create a guide version.
GuideVersion	postGuideVersions(String guideId, CreateGuideVersion body)	Create a guide version.
ApiResponse<GuideVersion>	postGuideVersionsWithHttpInfo(String guideId, CreateGuideVersion body)	Create a guide version.
SummarySetting	putConversationsSummariesSetting(PutConversationsSummariesSettingRequest request)	Update a summary setting.
ApiResponse<SummarySetting>	putConversationsSummariesSetting(ApiRequest<SummarySetting> request)	Update a summary setting.
SummarySetting	putConversationsSummariesSetting(String summarySettingId, SummarySetting body)	Update a summary setting.
ApiResponse<SummarySetting>	putConversationsSummariesSettingWithHttpInfo(String summarySettingId, SummarySetting body)	Update a summary setting.

Methods inherited from class java.lang.Object

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

Constructor Details

AIStudioApi

public AIStudioApi()

AIStudioApi

public AIStudioApi(ApiClient apiClient)

Method Details

deleteConversationsSummariesSetting

public void deleteConversationsSummariesSetting(String summarySettingId)
                                         throws IOException,
ApiException

Delete a summary setting.

Parameters:

summarySettingId - Summary setting id (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteConversationsSummariesSettingWithHttpInfo

public ApiResponse<Void> deleteConversationsSummariesSettingWithHttpInfo(String summarySettingId)
                                                                  throws IOException

Delete a summary setting.

Parameters:

summarySettingId - Summary setting id (required)

Throws:

IOException - if the request fails to be processed

deleteConversationsSummariesSetting

public void deleteConversationsSummariesSetting(DeleteConversationsSummariesSettingRequest request)
                                         throws IOException,
ApiException

Delete a summary setting.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteConversationsSummariesSetting

public ApiResponse<Void> deleteConversationsSummariesSetting(ApiRequest<Void> request)
                                                      throws IOException

Delete a summary setting.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteGuideJobs

public GuideJob deleteGuideJobs(String guideId)
                         throws IOException,
ApiException

Start the deletion of a guide.

Parameters:

guideId - Guide ID (required)

Returns:

GuideJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteGuideJobsWithHttpInfo

public ApiResponse<GuideJob> deleteGuideJobsWithHttpInfo(String guideId)
                                                  throws IOException

Start the deletion of a guide.

Parameters:

guideId - Guide ID (required)

Returns:

GuideJob

Throws:

IOException - if the request fails to be processed

deleteGuideJobs

public GuideJob deleteGuideJobs(DeleteGuideJobsRequest request)
                         throws IOException,
ApiException

Start the deletion of a guide.

Parameters:

request - The request object

Returns:

GuideJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteGuideJobs

public ApiResponse<GuideJob> deleteGuideJobs(ApiRequest<Void> request)
                                      throws IOException

Start the deletion of a guide.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getConversationsSummariesSetting

public SummarySetting getConversationsSummariesSetting(String summarySettingId)
                                                throws IOException,
ApiException

Receive a summary setting.

Parameters:

summarySettingId - Summary setting id (required)

Returns:

SummarySetting

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getConversationsSummariesSettingWithHttpInfo

public ApiResponse<SummarySetting> getConversationsSummariesSettingWithHttpInfo(String summarySettingId)
                                                                         throws IOException

Receive a summary setting.

Parameters:

summarySettingId - Summary setting id (required)

Returns:

SummarySetting

Throws:

IOException - if the request fails to be processed

getConversationsSummariesSetting

public SummarySetting getConversationsSummariesSetting(GetConversationsSummariesSettingRequest request)
                                                throws IOException,
ApiException

Receive a summary setting.

Parameters:

request - The request object

Returns:

SummarySetting

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getConversationsSummariesSetting

public ApiResponse<SummarySetting> getConversationsSummariesSetting(ApiRequest<Void> request)
                                                             throws IOException

Receive a summary setting.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getConversationsSummariesSettings

public SummarySettingEntityListing getConversationsSummariesSettings(Integer pageNumber,
 Integer pageSize,
 String name,
 String sortOrder,
 String language,
 String sortBy)
                                                              throws IOException,
ApiException

Get all summary settings.

Parameters:

pageNumber - Page number. (optional, default to 1)

pageSize - Page size. The maximum page size is 100. (optional, default to 25)

name - Filter by partially matching name - case insensitive. (optional)

sortOrder - Sort Order. Default value desc. (optional, default to desc)

language - Filter by matching language - case insensitive. (optional)

sortBy - Sort by. Default value dateModified. (optional, default to dateModified)

Returns:

SummarySettingEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getConversationsSummariesSettingsWithHttpInfo

public ApiResponse<SummarySettingEntityListing> getConversationsSummariesSettingsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String name,
 String sortOrder,
 String language,
 String sortBy)
                                                                                       throws IOException

Get all summary settings.

Parameters:

pageNumber - Page number. (optional, default to 1)

pageSize - Page size. The maximum page size is 100. (optional, default to 25)

name - Filter by partially matching name - case insensitive. (optional)

sortOrder - Sort Order. Default value desc. (optional, default to desc)

language - Filter by matching language - case insensitive. (optional)

sortBy - Sort by. Default value dateModified. (optional, default to dateModified)

Returns:

SummarySettingEntityListing

Throws:

IOException - if the request fails to be processed

getConversationsSummariesSettings

public SummarySettingEntityListing getConversationsSummariesSettings(GetConversationsSummariesSettingsRequest request)
                                                              throws IOException,
ApiException

Get all summary settings.

Parameters:

request - The request object

Returns:

SummarySettingEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getConversationsSummariesSettings

public ApiResponse<SummarySettingEntityListing> getConversationsSummariesSettings(ApiRequest<Void> request)
                                                                           throws IOException

Get all summary settings.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getGuide

public Guide getGuide(String guideId)
               throws IOException,
ApiException

Get guide.

Parameters:

guideId - Guide ID (required)

Returns:

Guide

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuideWithHttpInfo

public ApiResponse<Guide> getGuideWithHttpInfo(String guideId)
                                        throws IOException

Get guide.

Parameters:

guideId - Guide ID (required)

Returns:

Guide

Throws:

IOException - if the request fails to be processed

getGuide

public Guide getGuide(GetGuideRequest request)
               throws IOException,
ApiException

Get guide.

Parameters:

request - The request object

Returns:

Guide

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuide

public ApiResponse<Guide> getGuide(ApiRequest<Void> request)
                            throws IOException

Get guide.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getGuideJob

public GuideJob getGuideJob(String guideId,
 String jobId)
                     throws IOException,
ApiException

Get the specified guide deletion job.

Parameters:

guideId - Guide ID (required)

jobId - jobId (required)

Returns:

GuideJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuideJobWithHttpInfo

public ApiResponse<GuideJob> getGuideJobWithHttpInfo(String guideId,
 String jobId)
                                              throws IOException

Get the specified guide deletion job.

Parameters:

guideId - Guide ID (required)

jobId - jobId (required)

Returns:

GuideJob

Throws:

IOException - if the request fails to be processed

getGuideJob

public GuideJob getGuideJob(GetGuideJobRequest request)
                     throws IOException,
ApiException

Get the specified guide deletion job.

Parameters:

request - The request object

Returns:

GuideJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuideJob

public ApiResponse<GuideJob> getGuideJob(ApiRequest<Void> request)
                                  throws IOException

Get the specified guide deletion job.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getGuideVersion

public GuideVersion getGuideVersion(String guideId,
 String versionId)
                             throws IOException,
ApiException

Get a guide version.

Parameters:

guideId - Guide ID (required)

versionId - Version ID (required)

Returns:

GuideVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuideVersionWithHttpInfo

public ApiResponse<GuideVersion> getGuideVersionWithHttpInfo(String guideId,
 String versionId)
                                                      throws IOException

Get a guide version.

Parameters:

guideId - Guide ID (required)

versionId - Version ID (required)

Returns:

GuideVersion

Throws:

IOException - if the request fails to be processed

getGuideVersion

public GuideVersion getGuideVersion(GetGuideVersionRequest request)
                             throws IOException,
ApiException

Get a guide version.

Parameters:

request - The request object

Returns:

GuideVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuideVersion

public ApiResponse<GuideVersion> getGuideVersion(ApiRequest<Void> request)
                                          throws IOException

Get a guide version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getGuideVersionJob

public GuideVersionPublishJob getGuideVersionJob(String guideId,
 String versionId,
 String jobId)
                                          throws IOException,
ApiException

Get the status of the publishing job for this guide version.

Parameters:

guideId - Guide ID (required)

versionId - Version ID (required)

jobId - jobId (required)

Returns:

GuideVersionPublishJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuideVersionJobWithHttpInfo

public ApiResponse<GuideVersionPublishJob> getGuideVersionJobWithHttpInfo(String guideId,
 String versionId,
 String jobId)
                                                                   throws IOException

Get the status of the publishing job for this guide version.

Parameters:

guideId - Guide ID (required)

versionId - Version ID (required)

jobId - jobId (required)

Returns:

GuideVersionPublishJob

Throws:

IOException - if the request fails to be processed

getGuideVersionJob

public GuideVersionPublishJob getGuideVersionJob(GetGuideVersionJobRequest request)
                                          throws IOException,
ApiException

Get the status of the publishing job for this guide version.

Parameters:

request - The request object

Returns:

GuideVersionPublishJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuideVersionJob

public ApiResponse<GuideVersionPublishJob> getGuideVersionJob(ApiRequest<Void> request)
                                                       throws IOException

Get the status of the publishing job for this guide version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getGuides

public GuideEntityListing getGuides(String name,
 String nameContains,
 String status,
 String sortBy,
 String sortOrder,
 Integer pageNumber,
 Integer pageSize)
                             throws IOException,
ApiException

Get all guides.

Parameters:

name - Filter by matching name - case insensitive. (optional)

nameContains - Filter by name contains - case insensitive. (optional)

status - Filter by status. (optional)

sortBy - Sort by. Default value dateModified. (optional, default to dateModified)

sortOrder - Sort Order. Default value desc. (optional, default to desc)

pageNumber - Page number. (optional, default to 1)

pageSize - Page size. The maximum page size is 100. (optional, default to 25)

Returns:

GuideEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuidesWithHttpInfo

public ApiResponse<GuideEntityListing> getGuidesWithHttpInfo(String name,
 String nameContains,
 String status,
 String sortBy,
 String sortOrder,
 Integer pageNumber,
 Integer pageSize)
                                                      throws IOException

Get all guides.

Parameters:

name - Filter by matching name - case insensitive. (optional)

nameContains - Filter by name contains - case insensitive. (optional)

status - Filter by status. (optional)

sortBy - Sort by. Default value dateModified. (optional, default to dateModified)

sortOrder - Sort Order. Default value desc. (optional, default to desc)

pageNumber - Page number. (optional, default to 1)

pageSize - Page size. The maximum page size is 100. (optional, default to 25)

Returns:

GuideEntityListing

Throws:

IOException - if the request fails to be processed

getGuides

public GuideEntityListing getGuides(GetGuidesRequest request)
                             throws IOException,
ApiException

Get all guides.

Parameters:

request - The request object

Returns:

GuideEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuides

public ApiResponse<GuideEntityListing> getGuides(ApiRequest<Void> request)
                                          throws IOException

Get all guides.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getGuidesJob

public GuideContentGenerationJob getGuidesJob(String jobId)
                                       throws IOException,
ApiException

Get the status of the guide content generation job.

Parameters:

jobId - jobId (required)

Returns:

GuideContentGenerationJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuidesJobWithHttpInfo

public ApiResponse<GuideContentGenerationJob> getGuidesJobWithHttpInfo(String jobId)
                                                                throws IOException

Get the status of the guide content generation job.

Parameters:

jobId - jobId (required)

Returns:

GuideContentGenerationJob

Throws:

IOException - if the request fails to be processed

getGuidesJob

public GuideContentGenerationJob getGuidesJob(GetGuidesJobRequest request)
                                       throws IOException,
ApiException

Get the status of the guide content generation job.

Parameters:

request - The request object

Returns:

GuideContentGenerationJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getGuidesJob

public ApiResponse<GuideContentGenerationJob> getGuidesJob(ApiRequest<Void> request)
                                                    throws IOException

Get the status of the guide content generation job.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchGuide

public Guide patchGuide(String guideId,
 UpdateGuide body)
                 throws IOException,
ApiException

Update a guide.

Parameters:

guideId - Guide ID (required)

body - (required)

Returns:

Guide

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchGuideWithHttpInfo

public ApiResponse<Guide> patchGuideWithHttpInfo(String guideId,
 UpdateGuide body)
                                          throws IOException

Update a guide.

Parameters:

guideId - Guide ID (required)

body - (required)

Returns:

Guide

Throws:

IOException - if the request fails to be processed

patchGuide

public Guide patchGuide(PatchGuideRequest request)
                 throws IOException,
ApiException

Update a guide.

Parameters:

request - The request object

Returns:

Guide

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchGuide

public ApiResponse<Guide> patchGuide(ApiRequest<UpdateGuide> request)
                              throws IOException

Update a guide.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchGuideVersion

public GuideVersion patchGuideVersion(String guideId,
 String versionId,
 UpdateGuideVersion body)
                               throws IOException,
ApiException

Update a guide version.

Parameters:

guideId - Guide ID (required)

versionId - Version ID (required)

body - (required)

Returns:

GuideVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchGuideVersionWithHttpInfo

public ApiResponse<GuideVersion> patchGuideVersionWithHttpInfo(String guideId,
 String versionId,
 UpdateGuideVersion body)
                                                        throws IOException

Update a guide version.

Parameters:

guideId - Guide ID (required)

versionId - Version ID (required)

body - (required)

Returns:

GuideVersion

Throws:

IOException - if the request fails to be processed

patchGuideVersion

public GuideVersion patchGuideVersion(PatchGuideVersionRequest request)
                               throws IOException,
ApiException

Update a guide version.

Parameters:

request - The request object

Returns:

GuideVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchGuideVersion

public ApiResponse<GuideVersion> patchGuideVersion(ApiRequest<UpdateGuideVersion> request)
                                            throws IOException

Update a guide version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postConversationsSummariesPreview

public void postConversationsSummariesPreview(SummarySettingWithTranscript body)
                                       throws IOException,
ApiException

Trigger summary preview event generation.

Parameters:

body - (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postConversationsSummariesPreviewWithHttpInfo

public ApiResponse<Void> postConversationsSummariesPreviewWithHttpInfo(SummarySettingWithTranscript body)
                                                                throws IOException

Trigger summary preview event generation.

Parameters:

body - (required)

Throws:

IOException - if the request fails to be processed

postConversationsSummariesPreview

public void postConversationsSummariesPreview(PostConversationsSummariesPreviewRequest request)
                                       throws IOException,
ApiException

Trigger summary preview event generation.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postConversationsSummariesPreview

public ApiResponse<Void> postConversationsSummariesPreview(ApiRequest<SummarySettingWithTranscript> request)
                                                    throws IOException

Trigger summary preview event generation.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postConversationsSummariesSettings

public SummarySetting postConversationsSummariesSettings(SummarySetting body)
                                                  throws IOException,
ApiException

Create a summary setting.

Parameters:

body - (required)

Returns:

SummarySetting

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postConversationsSummariesSettingsWithHttpInfo

public ApiResponse<SummarySetting> postConversationsSummariesSettingsWithHttpInfo(SummarySetting body)
                                                                           throws IOException

Create a summary setting.

Parameters:

body - (required)

Returns:

SummarySetting

Throws:

IOException - if the request fails to be processed

postConversationsSummariesSettings

public SummarySetting postConversationsSummariesSettings(PostConversationsSummariesSettingsRequest request)
                                                  throws IOException,
ApiException

Create a summary setting.

Parameters:

request - The request object

Returns:

SummarySetting

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postConversationsSummariesSettings

public ApiResponse<SummarySetting> postConversationsSummariesSettings(ApiRequest<SummarySetting> request)
                                                               throws IOException

Create a summary setting.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postGuideSessionTurns

public GuideSessionTurnResponse postGuideSessionTurns(String guideId,
 String guideSessionId,
 GuideSessionTurnRequest body)
                                               throws IOException,
ApiException

Add a turn to a guide session. Creates a new turn in the specified guide session with the provided request data. If the session ID doesn't exist, a new session will be created automatically.

Parameters:

guideId - Guide ID (required)

guideSessionId - Guide Session ID (required)

body - (required)

Returns:

GuideSessionTurnResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuideSessionTurnsWithHttpInfo

public ApiResponse<GuideSessionTurnResponse> postGuideSessionTurnsWithHttpInfo(String guideId,
 String guideSessionId,
 GuideSessionTurnRequest body)
                                                                        throws IOException

Add a turn to a guide session. Creates a new turn in the specified guide session with the provided request data. If the session ID doesn't exist, a new session will be created automatically.

Parameters:

guideId - Guide ID (required)

guideSessionId - Guide Session ID (required)

body - (required)

Returns:

GuideSessionTurnResponse

Throws:

IOException - if the request fails to be processed

postGuideSessionTurns

public GuideSessionTurnResponse postGuideSessionTurns(PostGuideSessionTurnsRequest request)
                                               throws IOException,
ApiException

Add a turn to a guide session. Creates a new turn in the specified guide session with the provided request data. If the session ID doesn't exist, a new session will be created automatically.

Parameters:

request - The request object

Returns:

GuideSessionTurnResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuideSessionTurns

public ApiResponse<GuideSessionTurnResponse> postGuideSessionTurns(ApiRequest<GuideSessionTurnRequest> request)
                                                            throws IOException

Add a turn to a guide session. Creates a new turn in the specified guide session with the provided request data. If the session ID doesn't exist, a new session will be created automatically.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postGuideVersionJobs

public GuideVersionPublishJob postGuideVersionJobs(String guideId,
 String versionId,
 GuideVersionPublishJobRequest body)
                                            throws IOException,
ApiException

Start the publishing of a guide version.

Parameters:

guideId - Guide ID (required)

versionId - Version ID (required)

body - (required)

Returns:

GuideVersionPublishJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuideVersionJobsWithHttpInfo

public ApiResponse<GuideVersionPublishJob> postGuideVersionJobsWithHttpInfo(String guideId,
 String versionId,
 GuideVersionPublishJobRequest body)
                                                                     throws IOException

Start the publishing of a guide version.

Parameters:

guideId - Guide ID (required)

versionId - Version ID (required)

body - (required)

Returns:

GuideVersionPublishJob

Throws:

IOException - if the request fails to be processed

postGuideVersionJobs

public GuideVersionPublishJob postGuideVersionJobs(PostGuideVersionJobsRequest request)
                                            throws IOException,
ApiException

Start the publishing of a guide version.

Parameters:

request - The request object

Returns:

GuideVersionPublishJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuideVersionJobs

public ApiResponse<GuideVersionPublishJob> postGuideVersionJobs(ApiRequest<GuideVersionPublishJobRequest> request)
                                                         throws IOException

Start the publishing of a guide version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postGuideVersions

public GuideVersion postGuideVersions(String guideId,
 CreateGuideVersion body)
                               throws IOException,
ApiException

Create a guide version.

Parameters:

guideId - Guide ID (required)

body - (optional)

Returns:

GuideVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuideVersionsWithHttpInfo

public ApiResponse<GuideVersion> postGuideVersionsWithHttpInfo(String guideId,
 CreateGuideVersion body)
                                                        throws IOException

Create a guide version.

Parameters:

guideId - Guide ID (required)

body - (optional)

Returns:

GuideVersion

Throws:

IOException - if the request fails to be processed

postGuideVersions

public GuideVersion postGuideVersions(PostGuideVersionsRequest request)
                               throws IOException,
ApiException

Create a guide version.

Parameters:

request - The request object

Returns:

GuideVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuideVersions

public ApiResponse<GuideVersion> postGuideVersions(ApiRequest<CreateGuideVersion> request)
                                            throws IOException

Create a guide version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postGuides

public Guide postGuides(CreateGuide body)
                 throws IOException,
ApiException

Create a guide.

Parameters:

body - (required)

Returns:

Guide

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuidesWithHttpInfo

public ApiResponse<Guide> postGuidesWithHttpInfo(CreateGuide body)
                                          throws IOException

Create a guide.

Parameters:

body - (required)

Returns:

Guide

Throws:

IOException - if the request fails to be processed

postGuides

public Guide postGuides(PostGuidesRequest request)
                 throws IOException,
ApiException

Create a guide.

Parameters:

request - The request object

Returns:

Guide

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuides

public ApiResponse<Guide> postGuides(ApiRequest<CreateGuide> request)
                              throws IOException

Create a guide.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postGuidesJobs

public GuideContentGenerationJob postGuidesJobs(GenerateGuideContentRequest body)
                                         throws IOException,
ApiException

Start a guide content generation job.

Parameters:

body - (required)

Returns:

GuideContentGenerationJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuidesJobsWithHttpInfo

public ApiResponse<GuideContentGenerationJob> postGuidesJobsWithHttpInfo(GenerateGuideContentRequest body)
                                                                  throws IOException

Start a guide content generation job.

Parameters:

body - (required)

Returns:

GuideContentGenerationJob

Throws:

IOException - if the request fails to be processed

postGuidesJobs

public GuideContentGenerationJob postGuidesJobs(PostGuidesJobsRequest request)
                                         throws IOException,
ApiException

Start a guide content generation job.

Parameters:

request - The request object

Returns:

GuideContentGenerationJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuidesJobs

public ApiResponse<GuideContentGenerationJob> postGuidesJobs(ApiRequest<GenerateGuideContentRequest> request)
                                                      throws IOException

Start a guide content generation job.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postGuidesUploads

public UploadUrlResponse postGuidesUploads(UploadUrlRequest body)
                                    throws IOException,
ApiException

Generate presigned URL for uploading a file content to generate guide

Parameters:

body - query (required)

Returns:

UploadUrlResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuidesUploadsWithHttpInfo

public ApiResponse<UploadUrlResponse> postGuidesUploadsWithHttpInfo(UploadUrlRequest body)
                                                             throws IOException

Generate presigned URL for uploading a file content to generate guide

Parameters:

body - query (required)

Returns:

UploadUrlResponse

Throws:

IOException - if the request fails to be processed

postGuidesUploads

public UploadUrlResponse postGuidesUploads(PostGuidesUploadsRequest request)
                                    throws IOException,
ApiException

Generate presigned URL for uploading a file content to generate guide

Parameters:

request - The request object

Returns:

UploadUrlResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postGuidesUploads

public ApiResponse<UploadUrlResponse> postGuidesUploads(ApiRequest<UploadUrlRequest> request)
                                                 throws IOException

Generate presigned URL for uploading a file content to generate guide

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putConversationsSummariesSetting

public SummarySetting putConversationsSummariesSetting(String summarySettingId,
 SummarySetting body)
                                                throws IOException,
ApiException

Update a summary setting.

Parameters:

summarySettingId - Summary setting id (required)

body - (required)

Returns:

SummarySetting

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putConversationsSummariesSettingWithHttpInfo

public ApiResponse<SummarySetting> putConversationsSummariesSettingWithHttpInfo(String summarySettingId,
 SummarySetting body)
                                                                         throws IOException

Update a summary setting.

Parameters:

summarySettingId - Summary setting id (required)

body - (required)

Returns:

SummarySetting

Throws:

IOException - if the request fails to be processed

putConversationsSummariesSetting

public SummarySetting putConversationsSummariesSetting(PutConversationsSummariesSettingRequest request)
                                                throws IOException,
ApiException

Update a summary setting.

Parameters:

request - The request object

Returns:

SummarySetting

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putConversationsSummariesSetting

public ApiResponse<SummarySetting> putConversationsSummariesSetting(ApiRequest<SummarySetting> request)
                                                             throws IOException

Update a summary setting.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed